FCU API 2016-09-15

The Flexible Compute Unit (FCU) API enables you to manage your instances in the OUTSCALE Cloud.
It is compliant with the Elastic Compute Cloud (EC2) API of Amazon Web Services (AWS). See the AWS Compatibility Matrix.

Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.
Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.

Endpoints

Name	Base URL
ap-northeast-1	https://fcu.ap-northeast-1.outscale.com
cloudgouv-eu-west-1	https://fcu.cloudgouv-eu-west-1.outscale.com
eu-west-2 (default)	https://fcu.eu-west-2.outscale.com
us-east-2	https://fcu.us-east-2.outscale.com
us-west-1	https://fcu.us-west-1.outscale.com

Authentication Schemes

Access Key/Secret Key

The main way to authenticate your requests to this API is to use an access key and a secret key.
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in Signature of API Requests.

In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.

See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see About Access Keys.

No Authentication

A few API actions do not require any authentication. They are indicated as such in this documentation.

Other Security Mechanisms

In 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.
For more information, see Managing Your API Accesses.

Addresses

AllocateAddress

POST /AllocateAddress

Acquires an External IP (EIP) for your account.
An EIP is a static IP designed for dynamic Cloud computing. It can be used for instances in the public Cloud (standard) or in a Virtual Private Cloud (VPC), for a network interface, or for a NAT gateway.

For more information, see About Public IPs.
This AWS-compliant method corresponds to CreatePublicIp in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AllocateAddress --profile "default" \
  --Domain "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AllocateAddress' \
  --data-urlencode 'Domain=string'

Body (AllocateAddressRequest):

Body Parameter	Type	Description
Domain	string	The type of platform in which you want to use the EIP (`standard` \| `vpc`). The domain is for information only and does not modify the behavior of the EIP.

Response Elements

{
  "allocationId": "string",
  "domain": "string",
  "publicIp": "string",
  "requestId": "string"
}

Response 200 (AllocateAddressResponse):

Response Element	Type	Description
allocationId	string	The ID that represents the allocation of the EIP for use with instances in a VPC.
domain	string	The type of platform in which the EIP is allocated (`standard` \| `vpc`). This element is for information only.
publicIp	string	The EIP.
requestId	string	The ID of the request.

AssociateAddress

POST /AssociateAddress

Associates an External IP (EIP) with an instance or a network interface, in the public Cloud or in a Virtual Private Cloud (VPC). You can associate an EIP with only one instance or network interface at a time.
To associate an EIP in a VPC, ensure that the VPC has an internet gateway attached. For more information, see the AttachInternetGateway method.
By default, the EIP is disassociated every time you stop and start the instance. For a persistent association, you can add the osc.fcu.eip.auto-attach tag to the instance with the EIP as value. For more information, see the CreateTags method.

[IMPORTANT]
You can associate an EIP with a NAT gateway only when creating the NAT gateway. To modify its EIP, you need to delete the NAT gateway and re-create it with the new EIP. For more information, see the CreateNatGateway method.

This AWS-compliant method corresponds to LinkPublicIp in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AssociateAddress --profile "default" \
  --AllocationId "string" \
  --AllowReassociation True \
  --InstanceId "string" \
  --NetworkInterfaceId "string" \
  --PrivateIpAddress "string" \
  --PublicIp "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AssociateAddress' \
  --data-urlencode 'AllocationId=string' \
  --data-urlencode 'AllowReassociation=true' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'PrivateIpAddress=string' \
  --data-urlencode 'PublicIp=string'

Body (AssociateAddressRequest):

Body Parameter	Type	Description
AllocationId	string	The allocation ID of the EIP. In a VPC, this parameter is required.
AllowReassociation	boolean	- If set to true, allows the EIP to be associated with the instance or network interface that you specify even if it is already associated with another instance or network interface. - If set to false, prevents the EIP from being associated with the instance or network interface that you specify if it is already associated with another instance or network interface. (By default, true in the public Cloud, false in a VPC.)
InstanceId	string	The ID of the instance. - In the public Cloud, this parameter is required. - In a VPC, this parameter is required if the instance has only one network interface. Otherwise, you need to specify the `NetworkInterfaceId` parameter instead. You cannot specify both parameters at the same time.
NetworkInterfaceId	string	(VPC only) The ID of the network interface. This parameter is required if the instance has more than one network interface attached. Otherwise, you need to specify the `InstanceId` parameter instead. You cannot specify both parameters at the same time.
PrivateIpAddress	string	(VPC only) The primary or secondary private IP of the specified network interface. By default, the primary private IP.
PublicIp	string	The EIP. In the public Cloud, this parameter is required.

Response Elements

{
  "associationId": "string",
  "requestId": "string",
  "return": true
}

Response 200 (AssociateAddressResponse):

Response Element	Type	Description
associationId	string	(VPC only) The ID that represents the association of the EIP with the instance or the network interface.
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeAddresses

POST /DescribeAddresses

Describes one or more External IPs (EIPs) allocated to your account.
By default, this action returns information about all your EIPs: available, associated with an instance or network interface, or used for a NAT gateway.
You can use the Filter.N parameter to filter your EIPs on the following properties:

domain: Whether the EIP is for use in the public Cloud or in a VPC.
instance-id: The ID of the instance the address is associated with (if any).
public-ip: The EIP.
allocation-id: The allocation ID for the EIP.
association-id: The association ID for the EIP.
network-interface-id: The ID of the network interface the address is associated with (if any).
network-interface-owner-id: The account ID of the owner.
private-ip-address: The private IP associated with the EIP.

This AWS-compliant method corresponds to ReadPublicIps in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeAddresses --profile "default" \
  --AllocationId '["string"]' \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --PublicIp '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeAddresses' \
  --data-urlencode 'AllocationId.0=string' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'PublicIp.0=string'

Body (DescribeAddressesRequest):

Body Parameter	Type	Description
AllocationId	[string]	One ore more allocation IDs.
Filter	[Filter]	One or more filters.
Name	string	The name of the filter.
Value	[string]	One or more filter values.
PublicIp	[string]	One or more EIPs.

Response Elements

{
  "addressesSet": [
    {
      "allocationId": "string",
      "associationId": "string",
      "domain": "string",
      "instanceId": "string",
      "networkInterfaceId": "string",
      "networkInterfaceOwnerId": "string",
      "privateIpAddress": "string",
      "publicIp": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeAddressesResponse):

Response Element	Type	Description
addressesSet	[addressesSet]	Information about one or more EIPs.
allocationId	string	The ID of the address allocation for use with a VPC.
associationId	string	The ID of the address association with an instance in a VPC.
domain	string	Indicates whether the External IP is for use with instances in the public Cloud or in a VPC.
instanceId	string	The ID of the instance the address is associated with.
networkInterfaceId	string	The ID of the network interface.
networkInterfaceOwnerId	string	The account ID of the owner of the network interface.
privateIpAddress	string	The private IP associated with the External IP.
publicIp	string	The External IP.
requestId	string	The ID of the request.

DisassociateAddress

POST /DisassociateAddress

Disassociates an External IP (EIP) from the instance or network interface it is associated with.

[IMPORTANT]
To disassociate an EIP from a NAT gateway, you need to delete the NAT gateway. For more information, see the DeleteNatGateway method.

This AWS-compliant method corresponds to UnlinkPublicIp in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DisassociateAddress --profile "default" \
  --AssociationId "string" \
  --PublicIp "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DisassociateAddress' \
  --data-urlencode 'AssociationId=string' \
  --data-urlencode 'PublicIp=string'

Body (DisassociateAddressRequest):

Body Parameter	Type	Description
AssociationId	string	The ID that represents the association of the EIP with the instance or the network interface (required in a VPC).
PublicIp	string	The EIP (required in the public Cloud).

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DisassociateAddressResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

ReleaseAddress

POST /ReleaseAddress

Releases an External IP (EIP).
You can release an EIP associated with your account. This address is released in the EIP pool and can be used by someone else. Before releasing an EIP, ensure you updated all your resources communicating with this address.

This AWS-compliant method corresponds to DeletePublicIp in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ReleaseAddress --profile "default" \
  --AllocationId "string" \
  --PublicIp "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ReleaseAddress' \
  --data-urlencode 'AllocationId=string' \
  --data-urlencode 'PublicIp=string'

Body (ReleaseAddressRequest):

Body Parameter	Type	Description
AllocationId	string	The allocation ID of the EIP in your account (required in a VPC).
PublicIp	string	The EIP (required in the public Cloud).

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (ReleaseAddressResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

Customer Gateways

CreateCustomerGateway

POST /CreateCustomerGateway

Provides information about your customer gateway.
This action registers information to identify the customer gateway that you deployed in your network.
To open a tunnel to the customer gateway, you must provide the communication protocol type, the fixed public IP of the gateway, and an Autonomous System Number (ASN).

For more information, see About Client Gateways.
This AWS-compliant method corresponds to CreateClientGateway in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateCustomerGateway --profile "default" \
  --BgpAsn 0 \
  --IpAddress "string" \
  --Type "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateCustomerGateway' \
  --data-urlencode 'BgpAsn=0' \
  --data-urlencode 'IpAddress=string' \
  --data-urlencode 'Type=string'

Body (CreateCustomerGatewayRequest):

Body Parameter	Type	Description
BgpAsn	integer (int64)	The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the internet (by default, `65000`). This number must be between `1` and `4294967295`, except `50624`, `53306`, and `132418`. If you do not have an ASN, you can choose one between `64512` and `65534` (both included), or between `4200000000` and `4294967295` (both included).
IpAddress (required)	string	The public fixed IPv4 address of your customer gateway.
Type (required)	string	The communication protocol used to establish tunnel with your customer gateway (always `ipsec.1`).

Response Elements

{
  "customerGateway": {
    "bgpAsn": 0,
    "customerGatewayId": "string",
    "ipAddress": "string",
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string"
  },
  "requestId": "string"
}

Response 200 (CreateCustomerGatewayResponse):

Response Element	Type	Description
customerGateway	customerGateway	Information about the newly created customer gateway.
bgpAsn	integer (int64)	The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the internet.
customerGatewayId	string	The ID of the customer gateway.
ipAddress	string	The public IPv4 address of the customer gateway (must be a fixed address into a NATed network).
state	string	The state of the customer gateway (`pending` \| `available` \| `deleting` \| `deleted`).
tagSet	[tagSet_0]	One or more tags associated with the customer gateway.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
type	string	The type of communication tunnel used by the customer gateway (always `ipsec.1`).
requestId	string	The ID of the request.

DeleteCustomerGateway

POST /DeleteCustomerGateway

Deletes a customer gateway.
You must delete the VPN connection before deleting the customer gateway.

This AWS-compliant method corresponds to DeleteClientGateway in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteCustomerGateway --profile "default" \
  --CustomerGatewayId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteCustomerGateway' \
  --data-urlencode 'CustomerGatewayId=string'

Body (DeleteCustomerGatewayRequest):

Body Parameter	Type	Description
CustomerGatewayId (required)	string	The ID of the customer gateway you want to delete.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteCustomerGatewayResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeCustomerGateways

POST /DescribeCustomerGateways

Describes one or more of your customer gateways.
You can use the Filter.N parameter to filter the customer gateways on the following properties:

state: The state of the customer gateway (pending | available | deleting | deleted).
customer-gateway-id: The ID of the customer gateway.
ip-address: The public IPv4 address of the customer gateway.
bgp-asn: The ASN number.
type: The type of communication tunnel to the gateway.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

[NOTE]
If you provide an invalid customer gateway ID, a response 400 is returned without any information about customer gateways for which you provided a valid ID.

This AWS-compliant method corresponds to ReadClientGateways in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeCustomerGateways --profile "default" \
  --CustomerGatewayId '["string"]' \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeCustomerGateways' \
  --data-urlencode 'CustomerGatewayId.0=string' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string'

Body (DescribeCustomerGatewaysRequest):

Body Parameter	Type	Description
CustomerGatewayId	[string]	One or more customer gateways IDs.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeCustomerGateways \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.

Response Elements

{
  "customerGatewaySet": [
    {
      "bgpAsn": 0,
      "customerGatewayId": "string",
      "ipAddress": "string",
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeCustomerGatewaysResponse):

Response Element	Type	Description
customerGatewaySet	[customerGatewaySet]	One or more customer gateways.
bgpAsn	integer (int64)	The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the internet.
customerGatewayId	string	The ID of the customer gateway.
ipAddress	string	The public IPv4 address of the customer gateway (must be a fixed address into a NATed network).
state	string	The state of the customer gateway (`pending` \| `available` \| `deleting` \| `deleted`).
tagSet	[tagSet_0]	One or more tags associated with the customer gateway.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
type	string	The type of communication tunnel used by the customer gateway (always `ipsec.1`).
requestId	string	The ID of the request.

DHCP Options

AssociateDhcpOptions

POST /AssociateDhcpOptions

Associates a DHCP options set with a specified Virtual Private Cloud (VPC).

This AWS-compliant method corresponds to UpdateNet in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AssociateDhcpOptions --profile "default" \
  --DhcpOptionsId "string" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AssociateDhcpOptions' \
  --data-urlencode 'DhcpOptionsId=string' \
  --data-urlencode 'VpcId=string'

Body (AssociateDhcpOptionsRequest):

Body Parameter	Type	Description
DhcpOptionsId (required)	string	The ID of the DHCP options set, or `default` if you want to associate the default one.
VpcId (required)	string	The ID of the VPC.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (AssociateDhcpOptionsResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

CreateDhcpOptions

POST /CreateDhcpOptions

Creates a set of DHCP options that you can then associate with a Virtual Private Cloud (VPC).

For more information, see About DHCP Options.
This AWS-compliant method corresponds to CreateDhcpOptions in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateDhcpOptions --profile "default" \
  --DhcpConfiguration '[
      {
        "Key": "string",
        "Value": ["string"]
      }
    ]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateDhcpOptions' \
  --data-urlencode 'DhcpConfiguration.0.Key=string' \
  --data-urlencode 'DhcpConfiguration.0.Value.0=string'

Body (CreateDhcpOptionsRequest):

Body Parameter	Type	Description
DhcpConfiguration (required)	[DhcpConfiguration]	A DHCP configuration option.
Key	string	The type of DHCP option (`domain-name-servers` \| `domain-name` \| `ntp-servers` \| `log-servers`). For more information, see About DHCP Options.
Value	[string]	The values for the DHCP option (one to four IPs for the `domain-name-servers`, `ntp-servers` and `log-servers` options, or a domain name for the `domain-name` option). For more information, see About DHCP Options.

Response Elements

{
  "dhcpOptions": {
    "dhcpConfigurationSet": [
      {
        "key": "string",
        "valueSet": [
          {
            "value": "string"
          }
        ]
      }
    ],
    "dhcpOptionsId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "requestId": "string"
}

Response 200 (CreateDhcpOptionsResponse):

Response Element	Type	Description
dhcpOptions	dhcpOptions	A set of DHCP options.
dhcpConfigurationSet	[dhcpConfigurationSet]	One or more DHCP options in the set.
key	string	The name of an option in the DHCP configuration.
valueSet	[valueSet]	The value for the option in the DHCP configuration.
value	string	The value specified for the resource attribute.
dhcpOptionsId	string	The ID of the DHCP options set.
tagSet	[tagSet_0]	One or more tags associated with the DHCP options set.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
requestId	string	The ID of the request.

DeleteDhcpOptions

POST /DeleteDhcpOptions

Deletes a specified DHCP options set.
Before deleting a DHCP options set, you must disassociate it from the VPCs you associated it with. To do so, you need to associate with each VPC a new set of DHCP options, or the default one if you do not want to associate any DHCP options with the VPC.

[IMPORTANT]
You cannot delete the default set.

This AWS-compliant method corresponds to DeleteDhcpOptions in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteDhcpOptions --profile "default" \
  --DhcpOptionsId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteDhcpOptions' \
  --data-urlencode 'DhcpOptionsId=string'

Body (DeleteDhcpOptionsRequest):

Body Parameter	Type	Description
DhcpOptionsId (required)	string	The ID of the DHCP options set.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteDhcpOptionsResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeDhcpOptions

POST /DescribeDhcpOptions

Retrieves information about the content of one or more DHCP options sets.
You can use the Filter.N parameter to filter the described DHCP options sets on the following properties:

dhcp-options-id: The ID of a set of DHCP options.
key: The key for one of the options (domain-name-servers, domain-name, ntp-servers, or log-servers).
value: The value for one of the options.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

This AWS-compliant method corresponds to ReadDhcpOptions in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeDhcpOptions --profile "default" \
  --DhcpOptionsId '["string"]' \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeDhcpOptions' \
  --data-urlencode 'DhcpOptionsId.0=string' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string'

Body (DescribeDhcpOptionsRequest):

Body Parameter	Type	Description
DhcpOptionsId	[string]	One or more IDs of DHCP options sets. If you do not specify any ID, this action describes all your DHCP options sets.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeDhcpOptions \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.

Response Elements

{
  "dhcpOptionsSet": [
    {
      "dhcpConfigurationSet": [
        {
          "key": "string",
          "valueSet": [
            {
              "value": "string"
            }
          ]
        }
      ],
      "dhcpOptionsId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeDhcpOptionsResponse):

Response Element	Type	Description
dhcpOptionsSet	[dhcpOptionsSet]	One or more DHCP options sets.
dhcpConfigurationSet	[dhcpConfigurationSet]	One or more DHCP options in the set.
key	string	The name of an option in the DHCP configuration.
valueSet	[valueSet]	The value for the option in the DHCP configuration.
value	string	The value specified for the resource attribute.
dhcpOptionsId	string	The ID of the DHCP options set.
tagSet	[tagSet_0]	One or more tags associated with the DHCP options set.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
requestId	string	The ID of the request.

Images

CopyImage

POST /CopyImage

Copies an OUTSCALE machine image (OMI) to your account, from an account in the same Region.
To do so, the owner of the source OMI must share it with your account. For more information about how to share an OMI with another account, see ModifyImageAttribute.
The copy of the source OMI is independent and belongs to you.

[IMPORTANT]
To copy an OMI between accounts in different Regions, the owner of the source OMI must export it to an OUTSCALE Object Storage (OOS) bucket using the CreateImageExportTask method, and then you need to import it using the RegisterImage method. For more information, see CreateImageExportTask and RegisterImage.

This AWS-compliant method corresponds to CreateImage in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CopyImage --profile "default" \
  --Description "string" \
  --DryRun False \
  --Name "string" \
  --SourceImageId "string" \
  --SourceRegion "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CopyImage' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Name=string' \
  --data-urlencode 'SourceImageId=string' \
  --data-urlencode 'SourceRegion=string'

Body (CopyImageRequest):

Body Parameter	Type	Description
Description	string	A description of the new OMI.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Name	string	The name of the new OMI. This name must be unique for your account. If no name is specified, the name of the new OMI follows this pattern: "source OMI name-copyX", where X is the number of the copy.
SourceImageId (required)	string	The ID of the OMI you want to copy.
SourceRegion (required)	string	The name of the source Region, which must be the same as the Region of your account.

Response Elements

{
  "imageId": "string",
  "requestId": "string"
}

Response 200 (CopyImageResponse):

Response Element	Type	Description
imageId	string	The ID of the new OMI.
requestId	string	The ID of the request.

CreateImage

POST /CreateImage

Creates an OMI from an existing instance which is either running or stopped.
This action also creates a snapshot of the root volume of the instance, as well as a snapshot of each BSU volume attached to the instance.

For more information, see About OMIs.
This AWS-compliant method corresponds to CreateImage in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateImage --profile "default" \
  --Description "string" \
  --DryRun False \
  --InstanceId "string" \
  --Name "string" \
  --NoReboot True

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateImage' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'Name=string' \
  --data-urlencode 'NoReboot=true'

Body (CreateImageRequest):

Body Parameter	Type	Description
Description	string	A description for the new OMI.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
InstanceId (required)	string	The ID of the instance from which you want to create the OMI.
Name (required)	string	A unique name for the new OMI. Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces ( ), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`).
NoReboot	boolean	If set to false, the instance shuts down before creating the OMI and then reboots. If set to true, the instance does not.

Response Elements

{
  "imageId": "string",
  "requestId": "string"
}

Response 200 (CreateImageResponse):

Response Element	Type	Description
imageId	string	The ID of the new OMI.
requestId	string	The ID of the request.

CreateImageExportTask

POST /CreateImageExportTask

Exports an OUTSCALE machine image (OMI) to an OUTSCALE Object Storage (OOS) bucket.
This enables you to copy an OMI between accounts in different Regions.

This action creates the necessary snapshots and manifest file in the bucket. The OMI can then be imported to another account using a pre-signed URL of its manifest file. For more information, see Creating a Pre-Signed URL.

To copy an OMI in the same Region, you can also use the CopyImage method.

[IMPORTANT]
You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it.

For more information, see About OMIs.
This AWS-compliant method corresponds to CreateImageExportTask in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateImageExportTask --profile "default" \
  --ExportToOsu '{
      "DiskImageFormat": "string",
      "OsuAkSk": {
        "AccessKey": "string",
        "SecretKey": "string"
      },
      "OsuBucket": "string",
      "OsuPrefix": "string"
    }' \
  --ImageId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateImageExportTask' \
  --data-urlencode 'ExportToOsu.DiskImageFormat=string' \
  --data-urlencode 'ExportToOsu.OsuAkSk.AccessKey=string' \
  --data-urlencode 'ExportToOsu.OsuAkSk.SecretKey=string' \
  --data-urlencode 'ExportToOsu.OsuBucket=string' \
  --data-urlencode 'ExportToOsu.OsuPrefix=string' \
  --data-urlencode 'ImageId=string'

Body (CreateImageExportTaskRequest):

Body Parameter	Type	Description
ExportToOsu (required)	ExportToOsu_0	Information about the OMI export task.
DiskImageFormat (required)	string	The format of the export disk (`qcow2` \| `raw`).
OsuAkSk	OsuAkSk	The access key and secret key of the OOS account used to access the bucket.
AccessKey	string	The access key of the OOS account that enables you to access the bucket.
SecretKey	string	The secret key of the OOS account that enables you to access the bucket.
OsuBucket (required)	string	The name of the OOS bucket where you want to export the OMI.
OsuPrefix	string	The prefix for the key of the OOS object corresponding to the image.
ImageId (required)	string	The ID of the OMI to export.

Response Elements

{
  "imageExportTask": {
    "exportToOsu": {
      "diskImageFormat": "string",
      "osuAkSk": {
        "AccessKey": "string",
        "SecretKey": "string"
      },
      "osuBucket": "string",
      "osuManifestUrl": "string",
      "osuPrefix": "string"
    },
    "imageExport": {
      "imageId": "string"
    },
    "imageExportTaskId": "string",
    "state": "string",
    "statusMessage": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "requestId": "string"
}

Response 200 (CreateImageExportTaskResponse):

Response Element	Type	Description
imageExportTask	imageExportTask	Information about one or more image export tasks.
exportToOsu	exportToOsu_2	Information about the OMI export task.
diskImageFormat	string	The format of the export disk (`qcow2` \| `raw`).
osuAkSk	OsuAkSk	The access key and secret key of the OOS account used to access the bucket.
AccessKey	string	The access key of the OOS account that enables you to access the bucket.
SecretKey	string	The secret key of the OOS account that enables you to access the bucket.
osuBucket	string	The name of the OOS bucket where the OMI is exported.
osuManifestUrl	string	The URL of the manifest file.
osuPrefix	string	The prefix for the key of the OOS object corresponding to the image.
imageExport	imageExport	Information about the OMI you want to export.
imageId	string	The ID of the OMI to be exported.
imageExportTaskId	string	The ID of the OMI export task.
state	string	The state of the OMI export task (`pending/queued` \| `pending` \| `completed` \| `failed` \| `cancelled`).
statusMessage	string	If the OMI export task fails, an error message appears.
tagSet	[tagSet_0]	One or more tags associated with the OMI export task.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
requestId	string	The ID of the request.

DeregisterImage

POST /DeregisterImage

Deregisters an OUTSCALE machine image (OMI) so that you cannot use it anymore to launch instances. However, you can still use instances already launched from this OMI.

This AWS-compliant method corresponds to DeleteImage in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeregisterImage --profile "default" \
  --ImageId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeregisterImage' \
  --data-urlencode 'ImageId=string'

Body (DeregisterImageRequest):

Body Parameter	Type	Description
ImageId (required)	string	The ID of the OMI you want to deregister.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeregisterImageResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeImageAttribute

POST /DescribeImageAttribute

Describes a specified attribute of an OMI.
You can specify only one attribute at a time.

This AWS-compliant method corresponds to ReadImages in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeImageAttribute --profile "default" \
  --Attribute "string" \
  --ImageId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeImageAttribute' \
  --data-urlencode 'Attribute=string' \
  --data-urlencode 'ImageId=string'

Body (DescribeImageAttributeRequest):

Body Parameter	Type	Description
Attribute (required)	string	The OMI attribute (`description` \| `launchPermission` \| `productCodes`).
ImageId (required)	string	The ID of the OMI.

Response Elements

{
  "description": {
    "value": "string"
  },
  "imageId": "string",
  "launchPermission": [
    {
      "group": "string",
      "userId": "string"
    }
  ],
  "productCodes": [
    {
      "productCode": "string",
      "type": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeImageAttributeResponse):

Response Element	Type	Description
description	Description_1	The description of the resource.
value	string	The value specified for the resource attribute.
imageId	string	The ID of the OMI.
launchPermission	[launchPermission_1]	One or more launch permissions.
group	string	The name of the group (`all` if public).
userId	string	The ID of the account.
productCodes	[productCodes]	One or more product codes associated with the OMI.
productCode	string	The product code associated with the OMI.
type	string	The type of the product code associated with the OMI.
requestId	string	The ID of the request.

DescribeImageExportTasks

POST /DescribeImageExportTasks

Describes one or more image export tasks.

This AWS-compliant method corresponds to ReadImageExportTasks in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeImageExportTasks --profile "default" \
  --ImageExportTaskId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeImageExportTasks' \
  --data-urlencode 'ImageExportTaskId.0=string'

Body (DescribeImageExportTasksRequest):

Body Parameter	Type	Description
ImageExportTaskId	[string]	One or more image export tasks IDs.

Response Elements

{
  "imageExportTaskSet": [
    {
      "exportToOsu": {
        "diskImageFormat": "string",
        "osuAkSk": {
          "AccessKey": "string",
          "SecretKey": "string"
        },
        "osuBucket": "string",
        "osuManifestUrl": "string",
        "osuPrefix": "string"
      },
      "imageExport": {
        "imageId": "string"
      },
      "imageExportTaskId": "string",
      "state": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeImageExportTasksResponse):

Response Element	Type	Description
imageExportTaskSet	[imageExportTask]	Information about one or more image export tasks.
exportToOsu	exportToOsu_2	Information about the OMI export task.
diskImageFormat	string	The format of the export disk (`qcow2` \| `raw`).
osuAkSk	OsuAkSk	The access key and secret key of the OOS account used to access the bucket.
AccessKey	string	The access key of the OOS account that enables you to access the bucket.
SecretKey	string	The secret key of the OOS account that enables you to access the bucket.
osuBucket	string	The name of the OOS bucket where the OMI is exported.
osuManifestUrl	string	The URL of the manifest file.
osuPrefix	string	The prefix for the key of the OOS object corresponding to the image.
imageExport	imageExport	Information about the OMI you want to export.
imageId	string	The ID of the OMI to be exported.
imageExportTaskId	string	The ID of the OMI export task.
state	string	The state of the OMI export task (`pending/queued` \| `pending` \| `completed` \| `failed` \| `cancelled`).
statusMessage	string	If the OMI export task fails, an error message appears.
tagSet	[tagSet_0]	One or more tags associated with the OMI export task.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
requestId	string	The ID of the request.

DescribeImages

POST /DescribeImages

Describes one or more OMIs you can use.
You can filter the described OMIs using the ImageId.N, the Owner.N or the ExecutableBy.N parameters.
You can also use the Filter.N parameter to filter the OMIs on the following properties:

architecture: The architecture of the OMI (i386 | x86_64).
block-device-mapping.delete-on-termination: Whether the volume is deleted when terminating the instance.
block-device-mapping.device-name: The device name for the volume.
block-device-mapping.snapshot-id: The ID of the snapshot used to create the volume.
block-device-mapping.volume-size: The size of the volume, in gibibytes (GiB).
block-device-mapping.volume-type: The type of volume (standard | gp2 | io1).
description: The description of the OMI, provided when it was created.
hypervisor: The hypervisor type (always xen).
image-id: The ID of the OMI.
image-type: The type of OMI (always machine for official OMIs).
is-public: Whether the OMI has public launch permissions.
name: The name of the OMI, provided when it was created.
owner-alias: The account alias of the owner of the OMI.
owner-id: The account ID of the owner of the OMI.
platform: The platform.
product-code: The product code associated with the OMI.
product-code.type: The type of the product code associated with the OMI.
root-device-name: The device name of the root device (for example, /dev/sda1).
root-device-type: The type of root device used by the OMI (always ebs).
state: The current state of the OMI (pending | available | failed).
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.
virtualization-type: The virtualization type (always hvm).

This AWS-compliant method corresponds to ReadImages in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeImages --profile "default" \
  --ExecutableBy '["string"]' \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --ImageId '["string"]' \
  --Owner '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeImages' \
  --data-urlencode 'ExecutableBy.0=string' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'ImageId.0=string' \
  --data-urlencode 'Owner.0=string'

Body (DescribeImagesRequest):

Body Parameter	Type	Description
ExecutableBy	[string]	The account IDs which have launch permissions for the OMIs.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeImages \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
ImageId	[string]	One or more OMI IDs.
Owner	[string]	The account ID of one or more owners of OMIs. By default, all the OMIs for which you have launch permissions are described.

Response Elements

{
  "imagesSet": [
    {
      "architecture": "string",
      "blockDeviceMapping": [
        {
          "deviceName": "string",
          "ebs": {
            "deleteOnTermination": true,
            "iops": 0,
            "snapshotId": "string",
            "volumeSize": 0,
            "volumeType": "string"
          },
          "noDevice": "string",
          "virtualName": "string"
        }
      ],
      "description": "string",
      "hypervisor": "string",
      "imageId": "string",
      "imageLocation": "string",
      "imageOwnerAlias": "string",
      "imageOwnerId": "string",
      "imageState": "string",
      "imageType": "string",
      "isPublic": true,
      "name": "string",
      "platform": "string",
      "productCodes": [
        {
          "productCode": "string",
          "type": "string"
        }
      ],
      "rootDeviceName": "string",
      "rootDeviceType": "string",
      "stateReason": {
        "code": "string",
        "message": "string"
      },
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "virtualizationType": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeImagesResponse):

Response Element	Type	Description
imagesSet	[imagesSet]	Information about one or more OMIs.
architecture	string	The architecture of the OMI.
blockDeviceMapping	[BlockDeviceMapping_2]	One or more block device mapping entries.
deviceName	string	The name of the device.
ebs	Ebs_2	One or more parameters used to automatically set up volumes when you launch the instance.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
iops	integer	The number of I/O operations per second. This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
snapshotId	string	The ID of the snapshot used to create the volume.
volumeSize	integer	The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
volumeType	string	The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created. For more information about volumes types, see Volume Types and IOPS.
noDevice	string	Prevents a device from being mapped to `DeviceName` at launch, if the OMI used contains a mapping for `DeviceName`. To use this parameter, specify any value other than null, for example an empty string. Example with OSC CLI: `--BlockDeviceMapping.1.DeviceName "/dev/xvdb" \` `--BlockDeviceMapping.1.NoDevice ""`
virtualName	string	The name of an ephemeral storage disk (`ephemeralN`) to map to `DeviceName` at launch. You can specify either `Ebs` or `VirtualName`, but not both.
description	string	The description of the OMI, provided when it was created.
hypervisor	string	The hypervisor type of the instance (always `xen`).
imageId	string	The ID of OUTSCALE machine image (OMI).
imageLocation	string	The location of the bucket where the OMI files are stored.
imageOwnerAlias	string	The account alias of the owner of the OMI.
imageOwnerId	string	The account ID of the owner of the OMI.
imageState	string	The current state of the OMI (`pending` \| `available` \| `failed`).
imageType	string	The type of the OMI.
isPublic	boolean	If true, the OMI has public launch permissions.
name	string	The name of the OMI, provided when it was created.
platform	string	The value is `Windows` for Windows OMIs, or blank otherwise.
productCodes	[productCodes]	One or more product codes associated with the OMI.
productCode	string	The product code associated with the OMI.
type	string	The type of the product code associated with the OMI.
rootDeviceName	string	The name of the device to which the root device is plugged in (for example, `/dev/sda1`).
rootDeviceType	string	The type of root device used by the OMI.
stateReason	stateReason	The reason for the OMI state change.
code	string	The code of the change of state.
message	string	The message explaining the change of state.
tagSet	[tagSet_0]	One or more tags associated with the OMI.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
virtualizationType	string	The virtualization type.
requestId	string	The ID of the request.

ModifyImageAttribute

POST /ModifyImageAttribute

Modifies the specified attribute of an OUTSCALE machine image (OMI).
You can modify the permissions to access the OMI by adding or removing account IDs or groups. You can share an OMI with a user that is in the same Region. The user can create a copy of the OMI you shared, obtaining all the rights for the copy of the OMI. For more information, see CopyImage.

This AWS-compliant method corresponds to UpdateImage in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ModifyImageAttribute --profile "default" \
  --Description '{
      "Value": "string"
    }' \
  --ImageId "string" \
  --LaunchPermission '{
      "Add": [{"Group": "string", "UserId": "string"}],
      "Remove": [{"Group": "string", "UserId": "string"}]
    }' \
  --ProductCode '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyImageAttribute' \
  --data-urlencode 'Description.Value=string' \
  --data-urlencode 'ImageId=string' \
  --data-urlencode 'LaunchPermission.Add.0.Group=string' \
  --data-urlencode 'LaunchPermission.Add.0.UserId=string' \
  --data-urlencode 'LaunchPermission.Remove.0.Group=string' \
  --data-urlencode 'LaunchPermission.Remove.0.UserId=string' \
  --data-urlencode 'ProductCode.0=string'

Body (ModifyImageAttributeRequest):

Body Parameter	Type	Description
Description	Description_0	A new description of the resource.
Value	string	The value specified for the resource attribute.
ImageId (required)	string	The ID of the OMI.
LaunchPermission	LaunchPermission_0	Permissions to access the OMI. If you specify both `Add` and `Remove` attributes in the request, only `Add` is taken into account.
Add	[Add]	The account ID you want to add to the list of launch permissions for the OMI.
Group	string	The name of the group (`all` if public).
UserId	string	The ID of the account.
Remove	[Remove]	The account ID you want to remove from the list of launch permissions for the OMI.
Group	string	The name of the group (`all` if public).
UserId	string	The ID of the account.
ProductCode	[string]	One or more product codes to add to the OMI. Once a product code is applied to an OMI, it cannot be removed.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (ModifyImageAttributeResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

RegisterImage

POST /RegisterImage

Registers an OUTSCALE machine image (OMI) to finalize its creation process.
You can register an OMI either:

From a snapshot: You register an OMI from 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 ModifySnapshotAttribute method.
From a bucket by using a manifest file: You register an OMI from the manifest file of an OMI that was exported to an OUTSCALE Object Storage (OOS) bucket. First, the owner of the source OMI must export it to the bucket by using the CreateImageExportTask method. Then, they must grant you permission to read the manifest file via a pre-signed URL. For more information, see Creating a Pre-Signed URL.

Once the OMI is registered, you can launch an instance from this OMI. The copy of the source OMI is independent and belongs to you.

This AWS-compliant method corresponds to CreateImage in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu RegisterImage --profile "default" \
  --Architecture "string" \
  --BlockDeviceMapping '[
      {
        "DeviceName": "string",
        "Ebs": {"DeleteOnTermination": True, "Iops": 0, "SnapshotId": "string", "VolumeSize": 0, "VolumeType": "string"},
        "NoDevice": "string",
        "VirtualName": "string"
      }
    ]' \
  --Description "string" \
  --ImageLocation "string" \
  --Name "string" \
  --RootDeviceName "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RegisterImage' \
  --data-urlencode 'Architecture=string' \
  --data-urlencode 'BlockDeviceMapping.0.DeviceName=string' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.DeleteOnTermination=true' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.Iops=0' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.SnapshotId=string' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.VolumeSize=0' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.VolumeType=string' \
  --data-urlencode 'BlockDeviceMapping.0.NoDevice=string' \
  --data-urlencode 'BlockDeviceMapping.0.VirtualName=string' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'ImageLocation=string' \
  --data-urlencode 'Name=string' \
  --data-urlencode 'RootDeviceName=string'

Body (RegisterImageRequest):

Body Parameter	Type	Description
Architecture	string	The architecture of the OMI (set to `i386` by default).
BlockDeviceMapping	[BlockDeviceMapping_1]	One or more Block Device Mapping entries.
DeviceName	string	The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
Ebs	Ebs_0	One or more parameters to map a volume to `DeviceName` at launch.You can specify either `Ebs` or `VirtualName`, but not both.
DeleteOnTermination	boolean	By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
Iops	integer	The number of I/O operations per second. This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
SnapshotId	string	The ID of the snapshot used to create the volume.
VolumeSize	integer	The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
VolumeType	string	The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created. For more information about volumes types, see Volume Types and IOPS.
NoDevice	string	Prevents a device from being mapped to `DeviceName` at launch, if the OMI used contains a mapping for `DeviceName`. To use this parameter, specify any value other than null, for example an empty string. Example with OSC CLI: `--BlockDeviceMapping.1.DeviceName "/dev/xvdb" \` `--BlockDeviceMapping.1.NoDevice ""`
VirtualName	string	The name of an ephemeral storage disk (`ephemeralN`) to map to `DeviceName` at launch. You can specify either `Ebs` or `VirtualName`, but not both.
Description	string	A description for the OMI.
ImageLocation	string	The pre-signed URL of the OMI manifest file, or the full path to the OMI stored in a bucket. If you specify this parameter, a copy of the OMI is created in your account.
Name (required)	string	A unique name for the OMI.
RootDeviceName	string	The name of the root device. This value must be `/dev/sda1`.

Response Elements

{
  "imageId": "string",
  "requestId": "string"
}

Response 200 (RegisterImageResponse):

Response Element	Type	Description
imageId	string	The ID of the newly registered OMI.
requestId	string	The ID of the request.

Instances

DescribeInstanceAttribute

POST /DescribeInstanceAttribute

Describes a specified attribute of an instance.
You can specify only one attribute at a time. You can describe the sourceDestCheck attribute only if the instance is in a Virtual Private Cloud (VPC).

This AWS-compliant method corresponds to ReadVms in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeInstanceAttribute --profile "default" \
  --Attribute "string" \
  --InstanceId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInstanceAttribute' \
  --data-urlencode 'Attribute=string' \
  --data-urlencode 'InstanceId=string'

Body (DescribeInstanceAttributeRequest):

Body Parameter	Type	Description
Attribute (required)	string	The instance attribute (`ramdisk` \| `userData` \| `instanceInitiatedShutdownBehavior` \| `rootDeviceName` \| `instanceType` \| `blockDeviceMapping` \| `groupSet` \| `sourceDestCheck` \| `disableApiTermination`).
InstanceId (required)	string	The ID of the instance.

Response Elements

{
  "blockDeviceMapping": [
    {
      "deviceName": "string",
      "ebs": {
        "attachTime": "string",
        "deleteOnTermination": true,
        "status": "string",
        "volumeId": "string"
      }
    }
  ],
  "disableApiTermination": {
    "value": true
  },
  "ebsOptimized": {
    "value": true
  },
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "instanceId": "string",
  "instanceInitiatedShutdownBehavior": {
    "value": "string"
  },
  "instanceType": {
    "value": "string"
  },
  "ramdisk": {
    "Value": "string"
  },
  "requestId": "string",
  "rootDeviceName": {
    "Value": "string"
  },
  "sourceDestCheck": {
    "value": true
  },
  "userData": {
    "value": "string"
  }
}

Response 200 (DescribeInstanceAttributeResponse):

Response Element	Type	Description
blockDeviceMapping	[BlockDeviceMapping_3]	The block device mapping of the instance.
deviceName	string	The name of the instance device name.
ebs	ebs	One or more parameters used to automatically set up volumes when the instance is launched.
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
status	string	The attachment state (`attaching` \| `attached` \| `detaching` \| `detached`).
volumeId	string	The ID of the volume.
disableApiTermination	DisableApiTermination_1	If true, you cannot terminate the instance unless you change this parameter back to false.
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.
ebsOptimized	EbsOptimized_1	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.
groupSet	[groupSet]	The security groups associated with the instance.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
instanceId	string	The ID of the instance.
instanceInitiatedShutdownBehavior	InstanceInitiatedShutdownBehavior_1	Indicates whether the instance stops, terminates or restarts when you stop or terminate it.
value	string	The value specified for the resource attribute.
instanceType	InstanceType_1	The type of instance. For more information, see VM-Types.html">VM Types.
value	string	The value specified for the resource attribute.
ramdisk	ramdisk	The ID of the RAM disk.
Value	string	The value specified for the resource attribute.
requestId	string	The ID of the request.
rootDeviceName	rootDeviceName	The name of the root device.
Value	string	The value specified for the resource attribute.
sourceDestCheck	SourceDestCheck_1	(VPC only) If true, the source/destination check is enabled. If false, it is disabled.
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.
userData	UserData_1	The Base64-encoded MIME user data.
value	string	The value specified for the resource attribute.

DescribeInstanceStatus

POST /DescribeInstanceStatus

Describes the status of one or more instances.
You can use the Filter.N parameter to filter the described instances status on the following properties:

availability-zone: The Availability Zone of the instance.
event.code: The code for the scheduled event (system-reboot | system-maintenance).
event.description: The description of the scheduled event.
instance-state-code: The state of the instance: -1 (quarantine), 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name: The state of the instance (pending | running | stopping | stopped | shutting-down | terminated | quarantine).

This AWS-compliant method corresponds to ReadVmsState in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeInstanceStatus --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --IncludeAllInstances True \
  --InstanceId '["string"]' \
  --MaxResults 0 \
  --NextToken "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInstanceStatus' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'IncludeAllInstances=true' \
  --data-urlencode 'InstanceId.0=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string'

Body (DescribeInstanceStatusRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeInstanceStatus \` `--Filter.1.Name "availability-zone" \` `--Filter.1.Value.1 "eu-west-2a"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
IncludeAllInstances	boolean	If set to true, includes the status of all instances. By default or if set to false, only includes the status of running instances.
InstanceId	[string]	One or more instance IDs.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned. You cannot specify both this parameter and the InstanceId parameter in the same request.
NextToken	string	The token to request the next results page.

Response Elements

{
  "instanceStatusSet": [
    {
      "availabilityZone": "string",
      "eventsSet": [
        {
          "code": "string",
          "description": "string",
          "notAfter": "string",
          "notBefore": "string"
        }
      ],
      "instanceId": "string",
      "instanceState": {
        "code": 0,
        "name": "string"
      },
      "instanceStatus": {
        "details": [
          {
            "impairedSince": "string",
            "name": "string",
            "status": "string"
          }
        ],
        "status": "string"
      },
      "systemStatus": {
        "details": [
          {
            "impairedSince": "string",
            "name": "string",
            "status": "string"
          }
        ],
        "status": "string"
      }
    }
  ],
  "nextToken": "string",
  "requestId": "string"
}

Response 200 (DescribeInstanceStatusResponse):

Response Element	Type	Description
instanceStatusSet	[instanceStatusSet]	One or more instance status descriptions.
availabilityZone	string	The Availability Zone in which the instance is located.
eventsSet	[eventsSet]	One or more scheduled events associated with the instance.
code	string	The event code (`system-reboot` \| `system-maintenance`).
description	string	A description of the event.
notAfter	string	The latest scheduled end time for the event.
notBefore	string	The earliest scheduled start time for the event.
instanceId	string	The ID of the instance.
instanceState	instanceState	The state of the instance.
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
instanceStatus	instanceStatus	Impaired functionality that stems from issues internal to the instance (for example, impaired reachability).
details	[details]	The system instance health or application instance health.
impairedSince	string	The time at which a state check failed (for an instance that was launched and impaired, the time at which the instance was launched).
name	string	The type of instance state (always `reachability`).
status	string	The state of the instance.
status	string	The state of the instance.
systemStatus	systemStatus	Impaired functionality that stems from issues related to the systems supporting an instance (for example, hardware failures or network connectivity problems).
details	[details]	The system instance health or application instance health.
impairedSince	string	The time at which a state check failed (for an instance that was launched and impaired, the time at which the instance was launched).
name	string	The type of instance state (always `reachability`).
status	string	The state of the instance.
status	string	The state of the instance.
nextToken	string	The token to request the next results page. If the value is null, there is no results left to be returned.
requestId	string	The ID of the request.

DescribeInstances

POST /DescribeInstances

Describes one or more of your instances.
If you provide one or more instance IDs, this action returns a description for all of these instances. If you do not provide any instance ID, this action returns a description for all of the instances that belong to you. If you provide an invalid instance ID, an error is returned. If you provide the ID of an instance that does not belong to you, the description of this instance is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated instance may appear in the response.
You can use the Filter.N parameter to filter the described instances on the following properties:

architecture: The architecture of the instance (i386 | x86_64).
availability-zone: The Availability Zone of the instance.
block-device-mapping.attach-time: The attach time for a BSU volume mapped to the instance (for example, 2016-01-23T18:45:30.000Z).
block-device-mapping.delete-on-termination: Indicates whether the BSU volume is deleted when terminating the instance.
block-device-mapping.device-name: The device name for a BSU volume (in the format /dev/sdX, /dev/sdXX, /dev/xvdX, or /dev/xvdXX).
block-device-mapping.status: The status for the BSU volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id: The volume ID of a BSU volume.
client-token: The idempotency token provided when launching the instance.
group-id: The ID of the security group for the instance (only in the public Cloud).
group-name: The name of the security group for the instance (only in the public Cloud).
hypervisor: The hypervisor type of the instance (ovm | xen).
image-id: The ID of the image used to launch the instance.
instance-id: The ID of the instance.
instance-lifecycle: Indicates whether the instance is a Spot Instance (spot).
instance-state-code: The state of the instance: -1 (quarantine), 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name: The state of the instance (pending | running | stopping | stopped | shutting-down | terminated | quarantine).
instance-type: The instance type (for example, t2.micro). For more information, see VM-Types.html">VM Types.
instance.group-id: The ID of the security group for the instance.
instance.group-name: The name of the security group for the instance.
ip-address: The External IP (EIP) of the instance.
key-name: The name of the keypair used when launching the instance.
launch-index: The index for the instance when launching a group of several instances (for example, 0, 1, 2, and so on).
launch-time: The time when the instance was launched.
monitoring-state: Indicates whether monitoring is enabled for the instance (disabled | enabled).
owner-id: The OUTSCALE account ID of the instance owner.
placement-group-name: The name of the placement group for the instance.
platform: The platform. Use windows if you have Windows instances. Otherwise, leave this filter blank.
private-ip-address: The private IP of the instance.
product-code: The product code associated with the OMI used to launch the instance.
ramdisk-id: The ID of the RAM disk.
reason: The reason explaining the current state of the instance. This filter is like the state-reason-code one.
requester-id: The ID of the entity that launched the instance (for example, Cockpit or Auto Scaling).
reservation-id: The ID of the reservation of the instance, created every time you launch an instance. This reservation ID can be associated with several instances when you launch a group of instances using the same launch request.
root-device-name: The name of the root device for the instance (for example, /dev/sda1).
root-device-type: The root device type used by the instance (always ebs).
source-dest-check: If true, the source/destination checking is enabled. If false, it is disabled.
spot-instance-request-id: The ID of the Spot Instance request.
state-reason-code: The reason code for the state change.
state-reason-message: A message describing the state change.
subnet-id: The ID of the subnet for the instance.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.
tenancy: The tenancy of an instance (dedicated | default | host).
virtualization-type: The virtualization type of the instance (always hvm).
vpc-id: The ID of the VPC in which the instance is running.
network-interface.description: The description of the network interface.
network-interface.subnet-id: The ID of the subnet for the network interface.
network-interface.vpc-id: The ID of the VPC for the network interface.
network-interface.network-interface-id: The ID of the network interface.
network-interface.owner-id: The ID of the owner of the network interface.
network-interface.availability-zone: The Availability Zone for the network interface.
network-interface.requester-id: The requester ID for the network interface.
network-interface.requester-managed: Indicates whether the network interface is managed by 3DS OUTSCALE.
network-interface.status: The status of the network interface (available | in-use).
network-interface.mac-address: The MAC address of the network interface.
network-interface.source-dest-check: If true, the source/destination checking of the network interface is enabled. If false, it is disabled. The value must be false for the network interface to perform NAT (network address translation) in a VPC.
network-interface.group-id: The ID of a security group associated with the network interface.
network-interface.group-name: The name of a security group associated with the network interface.
network-interface.attachment.attachment-id: The ID of the interface attachment.
network-interface.attachment.instance-id: The ID of the instance the network interface is attached to.
network-interface.attachment.instance-owner-id: The account ID of the ID of the instance the network interface is attached to.
network-interface.attachment.device-index: The device index the network interface is attached to.
network-interface.attachment.status: The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time: The time when the network interface was attached to an instance.
network-interface.attachment.delete-on-termination: Indicates whether the attachment is deleted when terminating an instance.
network-interface.addresses.primary: Indicates whether the private IP of the network interface is the primary private IP.
network-interface.addresses.association.public-ip: The ID of the association of an EIP with a network interface.
network-interface.addresses.association.ip-owner-id: The account ID of the owner of the private IP associated with the network interface.
network-interface.addresses.private-ip-address: The private IP associated with the network interface.
network-interface.association.public-ip: The EIP associated with the network interface.
network-interface.association.ip-owner-id: The account ID of the owner of the EIP associated with the network interface.
network-interface.association.allocation-id: The allocation ID. This ID is returned when you allocate the EIP for your network interface.
network-interface.association.association-id: The association ID. This ID is returned when the network interface is associated with an IP.

This AWS-compliant method corresponds to ReadVms in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeInstances --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --InstanceId '["string"]' \
  --MaxResults 0 \
  --NextToken "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInstances' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'InstanceId.0=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string'

Body (DescribeInstancesRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeInstances \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
InstanceId	[string]	One or more instance IDs.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use NextToken to retrieve next results pages. This value is in between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned. You cannot specify both this parameter and the InstanceId parameter in the same request.
NextToken	string	The token to request the next results page.

Response Elements

{
  "nextToken": "string",
  "requestId": "string",
  "reservationSet": [
    {
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "instancesSet": [
        {
          "amiLaunchIndex": 0,
          "architecture": "string",
          "blockDeviceMapping": [
            {
              "deviceName": "string",
              "ebs": {
                "attachTime": "string",
                "deleteOnTermination": true,
                "status": "string",
                "volumeId": "string"
              }
            }
          ],
          "clientToken": "string",
          "dnsName": "string",
          "ebsOptimized": true,
          "groupSet": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "hypervisor": "string",
          "iamInstanceProfile": {
            "arn": "string",
            "id": "string"
          },
          "imageId": "string",
          "instanceId": "string",
          "instanceLifecycle": "string",
          "instanceState": {
            "code": 0,
            "name": "string"
          },
          "instanceType": "string",
          "ipAddress": "string",
          "kernelId": "string",
          "keyName": "string",
          "launchTime": "string",
          "monitoring": {
            "state": "string"
          },
          "networkInterfaceSet": [
            {
              "association": {
                "ipOwnerId": "string",
                "publicDnsName": "string",
                "publicIp": "string"
              },
              "attachment": {
                "attachTime": "string",
                "attachmentId": "string",
                "deleteOnTermination": true,
                "deviceIndex": 0,
                "status": "string"
              },
              "description": "string",
              "groupSet": [
                {
                  "groupId": "string",
                  "groupName": "string"
                }
              ],
              "macAddress": "string",
              "networkInterfaceId": "string",
              "ownerId": "string",
              "privateDnsName": "string",
              "privateIpAddress": "string",
              "privateIpAddressesSet": [
                {
                  "association": {
                    "ipOwnerId": "string",
                    "publicDnsName": "string",
                    "publicIp": "string"
                  },
                  "primary": true,
                  "privateDnsName": "string",
                  "privateIpAddress": "string"
                }
              ],
              "sourceDestCheck": true,
              "status": "string",
              "subnetId": "string",
              "vpcId": "string"
            }
          ],
          "placement": {
            "availabilityZone": "string",
            "groupName": "string",
            "tenancy": "string"
          },
          "platform": "string",
          "privateDnsName": "string",
          "privateIpAddress": "string",
          "productCodes": [
            {
              "productCode": "string",
              "type": "string"
            }
          ],
          "ramdiskId": "string",
          "reason": "string",
          "rootDeviceName": "string",
          "rootDeviceType": "string",
          "sourceDestCheck": true,
          "spotInstanceRequestId": "string",
          "sriovNetSupport": "string",
          "stateReason": {
            "code": "string",
            "message": "string"
          },
          "subnetId": "string",
          "tagSet": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "virtualizationType": "string",
          "vpcId": "string"
        }
      ],
      "ownerId": "string",
      "requesterId": "string",
      "reservationId": "string"
    }
  ]
}

Response 200 (DescribeInstancesResponse):

Response Element	Type	Description
nextToken	string	The token to specify to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.
reservationSet	[reservationSet]	Zero or more reservations.
groupSet	[groupSet]	One or more security groups.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
instancesSet	[instancesSet_0]	One or more instances.
amiLaunchIndex	integer	The launch index of the OMI.
architecture	string	The architecture of the image.
blockDeviceMapping	[BlockDeviceMapping_3]	One or more entries of block device mapping.
deviceName	string	The name of the instance device name.
ebs	ebs	One or more parameters used to automatically set up volumes when the instance is launched.
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
status	string	The attachment state (`attaching` \| `attached` \| `detaching` \| `detached`).
volumeId	string	The ID of the volume.
clientToken	string	A unique identifier which enables you to manage the idempotency.
dnsName	string	The name of the public DNS assigned to the instance.
ebsOptimized	boolean	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
groupSet	[groupSet]	One or more security groups for the instance.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
hypervisor	string	The hypervisor type of the instance.
iamInstanceProfile	iamInstanceProfile	The EIM instance profile associated with the instance.
arn	string	The unique identifier of the resource (between 20 and 2048 characters).
id	string	The ID of the instance profile.
imageId	string	The ID of the OMI.
instanceId	string	The ID of the instance.
instanceLifecycle	string	Indicates whether it is a spot instance.
instanceState	instanceState	The state of the instance.
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
instanceType	string	The type of instance. For more information, see VM Types.
ipAddress	string	The External IP (EIP) assigned to the instance.
kernelId	string	The ID of the kernel (always `null`).
keyName	string	The name of the keypair.
launchTime	string	The time at which the instance was launched.
monitoring	monitoring	The monitoring information for the instance.
state	string	The state of detail monitoring (`enabled` \| `disabled` \| `disabling` \| `pending`).
networkInterfaceSet	[networkInterfaceSet_0]	In a VPC, one or more network interfaces for the instance.
association	association_1	Information about an External IP associated with the interface.
ipOwnerId	string	The account ID of the owner of the External IP.
publicDnsName	string	The name of the public DNS.
publicIp	string	The External IP (EIP) associated with the network interface.
attachment	attachment_2	The attachment of the network interface.
attachTime	string	The time at which the attachment was initiated.
attachmentId	string	The ID of the network interface attachment.
deleteOnTermination	boolean	If true, the network interface is deleted when the instance is terminated.
deviceIndex	integer	The index of the instance device for the attachment.
status	string	The state of the network interface (`attaching` \| `attached` \| `detaching` \| `detached`).
description	string	The description of the network interface.
groupSet	[groupSet]	One or more security groups for the FNI.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
macAddress	string	The MAC address of the interface.
networkInterfaceId	string	The ID of the network interface.
ownerId	string	The account ID of the owner of the instance reservation.
privateDnsName	string	The name of the private DNS assigned to the instance.
privateIpAddress	string	The private IP assigned to the instance.
privateIpAddressesSet	[privateIpAddressesSet_1]	The private IPs assigned to the network interface.
association	association_1	Information about an External IP associated with the interface.
ipOwnerId	string	The account ID of the owner of the External IP.
publicDnsName	string	The name of the public DNS.
publicIp	string	The External IP (EIP) associated with the network interface.
primary	boolean	If true, the IP is the primary address of the network interface.
privateDnsName	string	The name of the private DNS.
privateIpAddress	string	The private IP of the network interface.
sourceDestCheck	boolean	If true in a VPC, the check to perform NAT is enabled.
status	string	The state of the interface.
subnetId	string	In a VPC, the ID of the subnet in which to launch the instance.
vpcId	string	The ID of the VPC in which the instance is launched.
placement	Placement_1	A specific placement where you want to create the instances.
availabilityZone	string	The Availability Zone of the instance.
groupName	string	The name of the placement group of the instance (always `null`).
tenancy	string	The tenancy of the instance (`default` \| `dedicated`).
platform	string	Indicates whether it is a Windows instance.
privateDnsName	string	The name of the private DNS assigned to the instance.
privateIpAddress	string	The private IP assigned to the instance.
productCodes	[productCodes]	The product codes attached to the instance.
productCode	string	The product code associated with the OMI.
type	string	The type of the product code associated with the OMI.
ramdiskId	string	The ID of the associated RAM disk.
reason	string	Information about the latest state change.
rootDeviceName	string	The name of the root device.
rootDeviceType	string	The type of root device used by the OMI.
sourceDestCheck	boolean	If true in a VPC, the check to perform NAT is enabled.
spotInstanceRequestId	string	The ID of the spot instance request.
sriovNetSupport	string	If true, the enhanced networking is enabled.
stateReason	stateReason	The reason for the OMI state change.
code	string	The code of the change of state.
message	string	The message explaining the change of state.
subnetId	string	In a VPC, the ID of the subnet in which you want to launch the instance.
tagSet	[tagSet_0]	One or more tags associated with the instance.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
virtualizationType	string	The virtualization type.
vpcId	string	The ID of the VPC in which the instance is launched.
ownerId	string	The account ID of the owner of the reservation.
requesterId	string	The ID of the requester that launched the instances on your behalf.
reservationId	string	The ID of the reservation.

GetConsoleOutput

POST /GetConsoleOutput

Gets the console output for an instance. This console provides the most recent 64 KiB output.

[IMPORTANT]
On Windows instances, the console is only handled on the first boot. It returns no output after the first boot.

This AWS-compliant method corresponds to ReadConsoleOutput in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu GetConsoleOutput --profile "default" \
  --InstanceId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=GetConsoleOutput' \
  --data-urlencode 'InstanceId=string'

Body (GetConsoleOutputRequest):

Body Parameter	Type	Description
InstanceId (required)	string	The ID of the instance.

Response Elements

{
  "instanceId": "string",
  "output": "string",
  "requestId": "string",
  "timestamp": "string"
}

Response 200 (GetConsoleOutputResponse):

Response Element	Type	Description
instanceId	string	The ID of the instance.
output	string	The Base64 encoded output of the console. If a command line tool is used, the output is decoded by the tools.
requestId	string	The ID of the request.
timestamp	string	The date and time the output was last updated, in ISO 8601 format.

GetPasswordData

POST /GetPasswordData

Retrieves the administrator password for a Windows running instance.
The administrator password is encrypted using the keypair you specified when launching the instance.

[IMPORTANT]

Only RSA keypairs can decrypt the password of a Windows instance.
The administrator password is generated only on the first boot of the Windows instance. It is not returned after the first boot.

This AWS-compliant method corresponds to ReadAdminPassword in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu GetPasswordData --profile "default" \
  --InstanceId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=GetPasswordData' \
  --data-urlencode 'InstanceId=string'

Body (GetPasswordDataRequest):

Body Parameter	Type	Description
InstanceId (required)	string	The ID of the instance.

Response Elements

{
  "instanceId": "string",
  "passwordData": "string",
  "requestId": "string",
  "timestamp": "string"
}

Response 200 (GetPasswordDataResponse):

Response Element	Type	Description
instanceId	string	The ID of the instance.
passwordData	string	The password of the instance. After the first boot, returns an empty string.
requestId	string	The ID of the request.
timestamp	string	The date and time the output was last updated, in ISO 8601 format.

ModifyInstanceAttribute

POST /ModifyInstanceAttribute

Modifies a specific attribute of an instance.
You can modify only one attribute at a time. You can modify the sourceDestCheck attribute only if the instance is in a Virtual Private Cloud (VPC).
You must stop the instance before modifying the following attributes:

InstanceType
UserData

This AWS-compliant method corresponds to UpdateVm in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ModifyInstanceAttribute --profile "default" \
  --BlockDeviceMapping '[
      {
        "DeviceName": "string",
        "Ebs": {"DeleteOnTermination": True, "VolumeId": "string"},
        "NoDevice": "string",
        "VirtualName": "string"
      }
    ]' \
  --DisableApiTermination '{
      "Value": True
    }' \
  --EbsOptimized '{
      "Value": True
    }' \
  --GroupId '["string"]' \
  --InstanceId "string" \
  --InstanceInitiatedShutdownBehavior '{
      "Value": "string"
    }' \
  --InstanceType '{
      "Value": "string"
    }' \
  --SourceDestCheck '{
      "Value": True
    }' \
  --UserData '{
      "Value": "string"
    }'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyInstanceAttribute' \
  --data-urlencode 'BlockDeviceMapping.0.DeviceName=string' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.DeleteOnTermination=true' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.VolumeId=string' \
  --data-urlencode 'BlockDeviceMapping.0.NoDevice=string' \
  --data-urlencode 'BlockDeviceMapping.0.VirtualName=string' \
  --data-urlencode 'DisableApiTermination.Value=true' \
  --data-urlencode 'EbsOptimized.Value=true' \
  --data-urlencode 'GroupId.0=string' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'InstanceInitiatedShutdownBehavior.Value=string' \
  --data-urlencode 'InstanceType.Value=string' \
  --data-urlencode 'SourceDestCheck.Value=true' \
  --data-urlencode 'UserData.Value=string'

Body (ModifyInstanceAttributeRequest):

Body Parameter	Type	Description
BlockDeviceMapping	[BlockDeviceMapping_0]	The block device mapping of the instance. This parameter modifies the `DeleteOnTermination` attribute for volumes attached to the instance.
DeviceName	string	The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
Ebs	Ebs_1	One or more parameters used to automatically set up volumes when you launch the instance.
DeleteOnTermination	boolean	By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
VolumeId	string	The ID of the volume.
NoDevice	string	Removes the specified device included in the block device mapping.
VirtualName	string	The name of the virtual device.
DisableApiTermination	DisableApiTermination_0	If true, you cannot terminate the instance unless you change this parameter back to false.
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.
EbsOptimized	EbsOptimized_0	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.
GroupId	[string]	A list of security groups IDs associated with the instance.
InstanceId (required)	string	The ID of the instance.
InstanceInitiatedShutdownBehavior	InstanceInitiatedShutdownBehavior_0	The instance behavior when you stop it. By default or if set to `stop`, the instance stops. If set to `restart`, the instance stops then automatically restarts. If set to `terminate`, the instance stops and is terminated.
Value	string	The value specified for the resource attribute.
InstanceType	InstanceType_0	The type of instance. For more information, see VM-Types.html">VM Types.
Value	string	The value specified for the resource attribute.
SourceDestCheck	SourceDestCheck_0	(VPC only) If true, the source/destination check is enabled. If false, it is disabled.
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.
UserData	UserData_0	The Base64-encoded MIME user data, limited to 500 kibibytes (KiB).
Value	string	The value to use for the resource attribute.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (ModifyInstanceAttributeResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

ModifyInstanceKeypair

POST /ModifyInstanceKeypair

Modifies the keypair associated with a specified instance.
When you replace the keypair of an instance with another one, the metadata of the instance is modified to reflect the new public key, but the replacement is still not effective in the operating system of the instance. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the instance. For more information, see Modifying the Keypair of a VM.
This AWS-compliant method corresponds to UpdateVm in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ModifyInstanceKeypair --profile "default" \
  --InstanceId "string" \
  --KeyName "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyInstanceKeypair' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'KeyName=string'

Body (ModifyInstanceKeypairRequest):

Body Parameter	Type	Description
InstanceId (required)	string	The ID of the instance.
KeyName (required)	string	The name of the keypair.

Response Elements

{
  "requestId": "string"
}

Response 200 (ModifyInstanceKeypairResponse):

Response Element	Type	Description
requestId	string	The ID of the request.

RebootInstances

POST /RebootInstances

Reboots one or more instances.
This operation sends a reboot request to one or more specified instance. This is an asynchronous action that queues this reboot request. This action only reboots instances that are valid and that belong to you.

This AWS-compliant method corresponds to RebootVms in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu RebootInstances --profile "default" \
  --InstanceId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RebootInstances' \
  --data-urlencode 'InstanceId.0=string'

Body (RebootInstancesRequest):

Body Parameter	Type	Description
InstanceId (required)	[string]	The IDs of the instances you want to reboot.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (RebootInstancesResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

RunInstances

POST /RunInstances

Creates instances, and then launches them.
This action enables you to create a specified number of instances using an OMI which you are allowed to use, and then to automatically launch them.
The instances remain in the pending state until they are created and ready to be used. Once automatically launched, they are in the running state.
To check the state of your instance, call the DescribeInstances method.
If not specified, the security group used by the service is the default one.
The metadata server enables you to get the public key provided when the instance is launched. Official OMIs contain a script to get this public key and put it inside the instance to provide secure access without password.

For more information, see About VMs.
This AWS-compliant method corresponds to CreateVms in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu RunInstances --profile "default" \
  --BlockDeviceMapping '[
      {
        "DeviceName": "string",
        "Ebs": {"DeleteOnTermination": True, "Iops": 0, "SnapshotId": "string", "VolumeSize": 0, "VolumeType": "string"},
        "NoDevice": "string",
        "VirtualName": "string"
      }
    ]' \
  --ClientToken "string" \
  --DisableApiTermination True \
  --DryRun False \
  --EbsOptimized True \
  --ImageId "string" \
  --InstanceInitiatedShutdownBehavior "string" \
  --InstanceType "string" \
  --KeyName "string" \
  --MaxCount 0 \
  --MinCount 0 \
  --NetworkInterface '[
      {
        "DeleteOnTermination": True,
        "Description": "string",
        "DeviceIndex": 0,
        "NetworkInterfaceId": "string",
        "PrivateIpAddress": "string",
        "PrivateIpAddressesSet": [{"Primary": True, "PrivateIpAddress": "string"}],
        "SecondaryPrivateIpAddressCount": 0,
        "SecurityGroupId": ["string"],
        "SubnetId": "string"
      }
    ]' \
  --Placement '{
      "AvailabilityZone": "string",
      "Tenancy": "string"
    }' \
  --PrivateIpAddress "string" \
  --PrivateIpAddresses "string" \
  --SecurityGroup '["string"]' \
  --SecurityGroupId '["string"]' \
  --SubnetId "string" \
  --UserData "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RunInstances' \
  --data-urlencode 'BlockDeviceMapping.0.DeviceName=string' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.DeleteOnTermination=true' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.Iops=0' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.SnapshotId=string' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.VolumeSize=0' \
  --data-urlencode 'BlockDeviceMapping.0.Ebs.VolumeType=string' \
  --data-urlencode 'BlockDeviceMapping.0.NoDevice=string' \
  --data-urlencode 'BlockDeviceMapping.0.VirtualName=string' \
  --data-urlencode 'ClientToken=string' \
  --data-urlencode 'DisableApiTermination=true' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'EbsOptimized=true' \
  --data-urlencode 'ImageId=string' \
  --data-urlencode 'InstanceInitiatedShutdownBehavior=string' \
  --data-urlencode 'InstanceType=string' \
  --data-urlencode 'KeyName=string' \
  --data-urlencode 'MaxCount=0' \
  --data-urlencode 'MinCount=0' \
  --data-urlencode 'NetworkInterface.0.DeleteOnTermination=true' \
  --data-urlencode 'NetworkInterface.0.Description=string' \
  --data-urlencode 'NetworkInterface.0.DeviceIndex=0' \
  --data-urlencode 'NetworkInterface.0.NetworkInterfaceId=string' \
  --data-urlencode 'NetworkInterface.0.PrivateIpAddress=string' \
  --data-urlencode 'NetworkInterface.0.PrivateIpAddressesSet.0.Primary=true' \
  --data-urlencode 'NetworkInterface.0.PrivateIpAddressesSet.0.PrivateIpAddress=string' \
  --data-urlencode 'NetworkInterface.0.SecondaryPrivateIpAddressCount=0' \
  --data-urlencode 'NetworkInterface.0.SecurityGroupId.0=string' \
  --data-urlencode 'NetworkInterface.0.SubnetId=string' \
  --data-urlencode 'Placement.AvailabilityZone=string' \
  --data-urlencode 'Placement.Tenancy=string' \
  --data-urlencode 'PrivateIpAddress=string' \
  --data-urlencode 'PrivateIpAddresses=string' \
  --data-urlencode 'SecurityGroup.0=string' \
  --data-urlencode 'SecurityGroupId.0=string' \
  --data-urlencode 'SubnetId=string' \
  --data-urlencode 'UserData=string'

Body (RunInstancesRequest):

Body Parameter	Type	Description
BlockDeviceMapping	[BlockDeviceMapping_1]	One or more block device mappings of the instance.
DeviceName	string	The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
Ebs	Ebs_0	One or more parameters to map a volume to `DeviceName` at launch.You can specify either `Ebs` or `VirtualName`, but not both.
DeleteOnTermination	boolean	By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
Iops	integer	The number of I/O operations per second. This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
SnapshotId	string	The ID of the snapshot used to create the volume.
VolumeSize	integer	The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
VolumeType	string	The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created. For more information about volumes types, see Volume Types and IOPS.
NoDevice	string	Prevents a device from being mapped to `DeviceName` at launch, if the OMI used contains a mapping for `DeviceName`. To use this parameter, specify any value other than null, for example an empty string. Example with OSC CLI: `--BlockDeviceMapping.1.DeviceName "/dev/xvdb" \` `--BlockDeviceMapping.1.NoDevice ""`
VirtualName	string	The name of an ephemeral storage disk (`ephemeralN`) to map to `DeviceName` at launch. You can specify either `Ebs` or `VirtualName`, but not both.
ClientToken	string	A unique identifier which enables you to manage the idempotency.
DisableApiTermination	boolean	If true, you cannot terminate the instance unless you change this parameter back to false.
DryRun	boolean	If true, checks whether you have the required permissions to perform the action.
EbsOptimized	boolean	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
ImageId (required)	string	The ID of the OMI. You can find the list of OMIs by calling the DescribeImages method.
InstanceInitiatedShutdownBehavior	string	The instance behavior when you stop it. By default or if set to `stop`, the instance stops. If set to `restart`, the instance stops then automatically restarts. If set to `terminate`, the instance stops and is terminated.
InstanceType	string	The type of instance. You can specify a TINA type (in the `tinavW.cXrYpZ` or `tinavW.cXrY` format), or an AWS type (for example, `t2.small`, which is the default value). If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. The TINA type is associated with a performance flag. For more information, see VM Types.
KeyName	string	The name of the keypair.
MaxCount (required)	integer	The maximum number of instances you want to launch. If all the instances cannot be created, the largest possible number of instances above MinCount are created and launched.
MinCount (required)	integer	The minimum number of instances you want to launch. If this number of instances cannot be created, FCU does not create and launch any instance.
NetworkInterface	[NetworkInterface_0]	One or more network interfaces. If you specify this parameter, you must define one network interface as the primary one of the instance with 0 as its device index.
DeleteOnTermination	boolean	By default or if set to true, the network interface is deleted when the instance is terminated. You can specify this parameter only for a new network interface. To modify this value for an existing network interface, see ModifyNetworkInterfaceAttribute.
Description	string	The description of the network interface, if you are creating a network interface when launching an instance.
DeviceIndex	integer	The index of the instance device for the network interface attachment (between `0` and `7`, both included). This parameter is required if you create a network interface when launching an instance.
NetworkInterfaceId	string	The ID of the network interface, if you are attaching an existing network interface when launching an instance.
PrivateIpAddress	string	The private IP of the network interface, if you are creating a network interface when launching an instance.
PrivateIpAddressesSet	[PrivateIpAddressesSet]	One or more private IPs to assign to the network interface (only one can be primary), if you are creating a network interface when launching an instance.
Primary	boolean	Indicates whether it is the primary private IP.
PrivateIpAddress	string	The private IPs.
SecondaryPrivateIpAddressCount	integer	The number of secondary private IPs (cannot be specified if you specified more than one private IP in the PrivateIPAddressesSet.N parameter), if you are creating a network interface when launching an instance.
SecurityGroupId	[string]	One or more IDs of the security groups of the network interface, if you are creating a network interface when launching an instance.
SubnetId	string	The ID of the subnet associated with the network string, if you are creating a network interface when launching an instance.
Placement	Placement_0	A specific placement where you want to create the instances (tenancy options).
AvailabilityZone	string	The Availability Zone of the instance.
Tenancy	string	The tenancy of the instance (`default` \| `dedicated`).
PrivateIpAddress	string	In a VPC, the unique primary IP. The IP must come from the IP range of the subnet.
PrivateIpAddresses	string	In a VPC, the list of primary IPs when you create several instances. The IPs must come from the IP range of the subnet.
SecurityGroup	[string]	One or more security group names.
SecurityGroupId	[string]	One or more security group IDs.
SubnetId	string	In a VPC, the ID of the subnet in which you want to launch the instance.
UserData	string	Data or script used to add a specific configuration to the instance. It must be Base64-encoded and is limited to 500 kibibytes (KiB).

Response Elements

{
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "instancesSet": [
    {
      "amiLaunchIndex": 0,
      "architecture": "string",
      "blockDeviceMapping": [
        {
          "deviceName": "string",
          "ebs": {
            "attachTime": "string",
            "deleteOnTermination": true,
            "status": "string",
            "volumeId": "string"
          }
        }
      ],
      "clientToken": "string",
      "dnsName": "string",
      "ebsOptimized": true,
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "hypervisor": "string",
      "iamInstanceProfile": {
        "arn": "string",
        "id": "string"
      },
      "imageId": "string",
      "instanceId": "string",
      "instanceLifecycle": "string",
      "instanceState": {
        "code": 0,
        "name": "string"
      },
      "instanceType": "string",
      "ipAddress": "string",
      "kernelId": "string",
      "keyName": "string",
      "launchTime": "string",
      "monitoring": {
        "state": "string"
      },
      "networkInterfaceSet": [
        {
          "association": {
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "attachment": {
            "attachTime": "string",
            "attachmentId": "string",
            "deleteOnTermination": true,
            "deviceIndex": 0,
            "status": "string"
          },
          "description": "string",
          "groupSet": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "macAddress": "string",
          "networkInterfaceId": "string",
          "ownerId": "string",
          "privateDnsName": "string",
          "privateIpAddress": "string",
          "privateIpAddressesSet": [
            {
              "association": {
                "ipOwnerId": "string",
                "publicDnsName": "string",
                "publicIp": "string"
              },
              "primary": true,
              "privateDnsName": "string",
              "privateIpAddress": "string"
            }
          ],
          "sourceDestCheck": true,
          "status": "string",
          "subnetId": "string",
          "vpcId": "string"
        }
      ],
      "placement": {
        "availabilityZone": "string",
        "groupName": "string",
        "tenancy": "string"
      },
      "platform": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "productCodes": [
        {
          "productCode": "string",
          "type": "string"
        }
      ],
      "ramdiskId": "string",
      "reason": "string",
      "rootDeviceName": "string",
      "rootDeviceType": "string",
      "sourceDestCheck": true,
      "spotInstanceRequestId": "string",
      "sriovNetSupport": "string",
      "stateReason": {
        "code": "string",
        "message": "string"
      },
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "virtualizationType": "string",
      "vpcId": "string"
    }
  ],
  "ownerId": "string",
  "requestId": "string",
  "requesterId": "string",
  "reservationId": "string"
}

Response 200 (RunInstancesResponse):

Response Element	Type	Description
groupSet	[groupSet]	One or more security groups.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
instancesSet	[instancesSet_0]	One or more instances.
amiLaunchIndex	integer	The launch index of the OMI.
architecture	string	The architecture of the image.
blockDeviceMapping	[BlockDeviceMapping_3]	One or more entries of block device mapping.
deviceName	string	The name of the instance device name.
ebs	ebs	One or more parameters used to automatically set up volumes when the instance is launched.
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
status	string	The attachment state (`attaching` \| `attached` \| `detaching` \| `detached`).
volumeId	string	The ID of the volume.
clientToken	string	A unique identifier which enables you to manage the idempotency.
dnsName	string	The name of the public DNS assigned to the instance.
ebsOptimized	boolean	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
groupSet	[groupSet]	One or more security groups for the instance.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
hypervisor	string	The hypervisor type of the instance.
iamInstanceProfile	iamInstanceProfile	The EIM instance profile associated with the instance.
arn	string	The unique identifier of the resource (between 20 and 2048 characters).
id	string	The ID of the instance profile.
imageId	string	The ID of the OMI.
instanceId	string	The ID of the instance.
instanceLifecycle	string	Indicates whether it is a spot instance.
instanceState	instanceState	The state of the instance.
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
instanceType	string	The type of instance. For more information, see VM Types.
ipAddress	string	The External IP (EIP) assigned to the instance.
kernelId	string	The ID of the kernel (always `null`).
keyName	string	The name of the keypair.
launchTime	string	The time at which the instance was launched.
monitoring	monitoring	The monitoring information for the instance.
state	string	The state of detail monitoring (`enabled` \| `disabled` \| `disabling` \| `pending`).
networkInterfaceSet	[networkInterfaceSet_0]	In a VPC, one or more network interfaces for the instance.
association	association_1	Information about an External IP associated with the interface.
ipOwnerId	string	The account ID of the owner of the External IP.
publicDnsName	string	The name of the public DNS.
publicIp	string	The External IP (EIP) associated with the network interface.
attachment	attachment_2	The attachment of the network interface.
attachTime	string	The time at which the attachment was initiated.
attachmentId	string	The ID of the network interface attachment.
deleteOnTermination	boolean	If true, the network interface is deleted when the instance is terminated.
deviceIndex	integer	The index of the instance device for the attachment.
status	string	The state of the network interface (`attaching` \| `attached` \| `detaching` \| `detached`).
description	string	The description of the network interface.
groupSet	[groupSet]	One or more security groups for the FNI.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
macAddress	string	The MAC address of the interface.
networkInterfaceId	string	The ID of the network interface.
ownerId	string	The account ID of the owner of the instance reservation.
privateDnsName	string	The name of the private DNS assigned to the instance.
privateIpAddress	string	The private IP assigned to the instance.
privateIpAddressesSet	[privateIpAddressesSet_1]	The private IPs assigned to the network interface.
association	association_1	Information about an External IP associated with the interface.
ipOwnerId	string	The account ID of the owner of the External IP.
publicDnsName	string	The name of the public DNS.
publicIp	string	The External IP (EIP) associated with the network interface.
primary	boolean	If true, the IP is the primary address of the network interface.
privateDnsName	string	The name of the private DNS.
privateIpAddress	string	The private IP of the network interface.
sourceDestCheck	boolean	If true in a VPC, the check to perform NAT is enabled.
status	string	The state of the interface.
subnetId	string	In a VPC, the ID of the subnet in which to launch the instance.
vpcId	string	The ID of the VPC in which the instance is launched.
placement	Placement_1	A specific placement where you want to create the instances.
availabilityZone	string	The Availability Zone of the instance.
groupName	string	The name of the placement group of the instance (always `null`).
tenancy	string	The tenancy of the instance (`default` \| `dedicated`).
platform	string	Indicates whether it is a Windows instance.
privateDnsName	string	The name of the private DNS assigned to the instance.
privateIpAddress	string	The private IP assigned to the instance.
productCodes	[productCodes]	The product codes attached to the instance.
productCode	string	The product code associated with the OMI.
type	string	The type of the product code associated with the OMI.
ramdiskId	string	The ID of the associated RAM disk.
reason	string	Information about the latest state change.
rootDeviceName	string	The name of the root device.
rootDeviceType	string	The type of root device used by the OMI.
sourceDestCheck	boolean	If true in a VPC, the check to perform NAT is enabled.
spotInstanceRequestId	string	The ID of the spot instance request.
sriovNetSupport	string	If true, the enhanced networking is enabled.
stateReason	stateReason	The reason for the OMI state change.
code	string	The code of the change of state.
message	string	The message explaining the change of state.
subnetId	string	In a VPC, the ID of the subnet in which you want to launch the instance.
tagSet	[tagSet_0]	One or more tags associated with the instance.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
virtualizationType	string	The virtualization type.
vpcId	string	The ID of the VPC in which the instance is launched.
ownerId	string	The ID of the account which has reserved the instances.
requestId	string	The ID of the request.
requesterId	string	The ID of the requester.
reservationId	string	Zero or more reservations, giving you information about your request.

StartInstances

POST /StartInstances

Start one or more instances.
You can start only instances that are valid and that belong to you.

This AWS-compliant method corresponds to StartVms in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu StartInstances --profile "default" \
  --InstanceId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=StartInstances' \
  --data-urlencode 'InstanceId.0=string'

Body (StartInstancesRequest):

Body Parameter	Type	Description
InstanceId (required)	[string]	One or more instance IDs.

Response Elements

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

Response 200 (StartInstancesResponse):

Response Element	Type	Description
instancesSet	[instancesSet_1]	Information about the started instances.
currentState	currentState	The current state of the instance.
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
instanceId	string	The ID of the instance.
previousState	previousState	The previous state of the instance.
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
requestId	string	The ID of the request.

StopInstances

POST /StopInstances

Stops one or more running instances.
You can stop only instances that are valid and that belong to you. Data stored in the instance RAM is lost.

This AWS-compliant method corresponds to StopVms in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu StopInstances --profile "default" \
  --Force True \
  --InstanceId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=StopInstances' \
  --data-urlencode 'Force=true' \
  --data-urlencode 'InstanceId.0=string'

Body (StopInstancesRequest):

Body Parameter	Type	Description
Force	boolean	Forces the instance to stop.
InstanceId (required)	[string]	One or more instance IDs.

Response Elements

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

Response 200 (StopInstancesResponse):

Response Element	Type	Description
instancesSet	[instancesSet_1]	Information about one or more stopped instances.
currentState	currentState	The current state of the instance.
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
instanceId	string	The ID of the instance.
previousState	previousState	The previous state of the instance.
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
requestId	string	The ID of the request.

TerminateInstances

POST /TerminateInstances

Terminates one or more instances.
This operation is idempotent, which means that all calls succeed if you terminate an instance more than once.

This AWS-compliant method corresponds to DeleteVms in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu TerminateInstances --profile "default" \
  --InstanceId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=TerminateInstances' \
  --data-urlencode 'InstanceId.0=string'

Body (TerminateInstancesRequest):

Body Parameter	Type	Description
InstanceId (required)	[string]	One or more instance IDs.

Response Elements

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

Response 200 (TerminateInstancesResponse):

Response Element	Type	Description
instancesSet	[instancesSet_1]	Information about one or more terminated instances.
currentState	currentState	The current state of the instance.
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
instanceId	string	The ID of the instance.
previousState	previousState	The previous state of the instance.
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
requestId	string	The ID of the request.

Internet Gateways

AttachInternetGateway

POST /AttachInternetGateway

Attaches an internet gateway to a Virtual Private Cloud (VPC).
To enable the connection between the Internet and a VPC, you must attach an internet gateway to this VPC.

This AWS-compliant method corresponds to LinkInternetService in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AttachInternetGateway --profile "default" \
  --InternetGatewayId "string" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AttachInternetGateway' \
  --data-urlencode 'InternetGatewayId=string' \
  --data-urlencode 'VpcId=string'

Body (AttachInternetGatewayRequest):

Body Parameter	Type	Description
InternetGatewayId (required)	string	The ID of the internet gateway.
VpcId (required)	string	The ID of the VPC.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (AttachInternetGatewayResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

CreateInternetGateway

POST /CreateInternetGateway

Creates an internet gateway you can use with a VPC.
An internet gateway enables instances launched in a VPC to connect to the internet. It allows routing of incoming and outgoing internet traffic and management of External IPs (EIPs).

For more information, see About Internet Services.
This AWS-compliant method corresponds to CreateInternetService in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateInternetGateway --profile "default"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateInternetGateway'

Body (CreateInternetGatewayRequest):

Body Parameter	Type	Description

Response Elements

{
  "internetGateway": {
    "internetGatewayId": "string",
    "attachmentSet": [
      {
        "state": "string",
        "vpcId": "string"
      }
    ],
    "tagSet": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "requestId": "string"
}

Response 200 (CreateInternetGatewayResponse):

Response Element	Type	Description
internetGateway	internetGateway	Information about the newly created internet gateway.
internetGatewayId	string	The ID of the internet gateway.
attachmentSet	[attachmentSet_1]	One or more VPCs attached to the internet gateway.
state	string	The state of the attachment (always `available`).
vpcId	string	The ID of the VPC.
tagSet	[Tag]	One or more tags associated with the internet gateway.
Key	string	The key of the tag, with a minimum of 1 character.
Value	string	The value of the tag, between 0 and 255 characters.
requestId	string	The ID of the request.

DeleteInternetGateway

POST /DeleteInternetGateway

Deletes an internet gateway.
Before deleting an internet gateway, you must detach it from any Virtual Private Cloud (VPC) it is attached to.

This AWS-compliant method corresponds to DeleteInternetService in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteInternetGateway --profile "default" \
  --InternetGatewayId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteInternetGateway' \
  --data-urlencode 'InternetGatewayId=string'

Body (DeleteInternetGatewayRequest):

Body Parameter	Type	Description
InternetGatewayId (required)	string	The ID of the internet gateway.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteInternetGatewayResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeInternetGateways

POST /DescribeInternetGateways

Describes one or more of your internet gateways.
An internet gateway enables instances launched in a VPC to connect to the internet. It allows routing of incoming and outgoing internet traffic and management of External IPs (EIPs).
You can use the Filter.N parameter to filter the described internet gateways on the following properties:

attachment.state: The current state of the attachment between the internet gateway and the VPC.
attachment.vpc-id: The ID of an attached VPC.
internet-gateway-id: The ID of the internet gateway.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

This AWS-compliant method corresponds to ReadInternetServices in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeInternetGateways --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --InternetGatewayId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInternetGateways' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'InternetGatewayId.0=string'

Body (DescribeInternetGatewaysRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeInternetGateways \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
InternetGatewayId	[string]	One or more internet gateways IDs.

Response Elements

{
  "internetGatewaySet": [
    {
      "attachmentSet": [
        {
          "state": "string",
          "vpcId": "string"
        }
      ],
      "internetGatewayId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeInternetGatewaysResponse):

Response Element	Type	Description
internetGatewaySet	[internetGatewaySet]	Information about one or more internet gateways.
attachmentSet	[attachmentSet_1]	One or more VPCs attached to the internet gateway.
state	string	The state of the attachment (always `available`).
vpcId	string	The ID of the VPC.
internetGatewayId	string	The ID of the internet gateway.
tagSet	[tagSet_0]	One or more tags associated with the internet gateway.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
requestId	string	The ID of the request.

DetachInternetGateway

POST /DetachInternetGateway

Detaches an internet gateway from a Virtual Private Cloud (VPC).
This action disables and detaches an internet gateway from a VPC. The VPC must not contain instances using External IPs (EIPs) nor internet-facing load balancers.

This AWS-compliant method corresponds to UnlinkInternetService in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DetachInternetGateway --profile "default" \
  --InternetGatewayId "string" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DetachInternetGateway' \
  --data-urlencode 'InternetGatewayId=string' \
  --data-urlencode 'VpcId=string'

Body (DetachInternetGatewayRequest):

Body Parameter	Type	Description
InternetGatewayId (required)	string	The ID of the internet gateway.
VpcId (required)	string	The ID of the VPC.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DetachInternetGatewayResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

Keypairs

CreateKeyPair

POST /CreateKeyPair

Creates a 2048-bit RSA keypair with a specified name.
This action returns the private key that you need to save. The public key is stored by 3DS OUTSCALE.

For more information, see About Keypairs.
This AWS-compliant method corresponds to CreateKeypair in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateKeyPair --profile "default" \
  --KeyName "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateKeyPair' \
  --data-urlencode 'KeyName=string'

Body (CreateKeyPairRequest):

Body Parameter	Type	Description
KeyName (required)	string	A unique name for the keypair, with a maximum length of 255 ASCII printable characters.

Response Elements

{
  "keyFingerprint": "string",
  "keyMaterial": "string",
  "keyName": "string",
  "requestId": "string"
}

Response 200 (CreateKeyPairResponse):

Response Element	Type	Description
keyFingerprint	string	The MD5 public key fingerprint as specified in section 4 of RFC 4716.
keyMaterial	string	The private key. When saving the private key in a .rsa file, replace the `\n` escape sequences with line breaks.
keyName	string	A unique name for the keypair.
requestId	string	The ID of the request.

DeleteKeyPair

POST /DeleteKeyPair

Deletes the specified keypair.
This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair.

This AWS-compliant method corresponds to DeleteKeypair in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteKeyPair --profile "default" \
  --KeyName "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteKeyPair' \
  --data-urlencode 'KeyName=string'

Body (DeleteKeyPairRequest):

Body Parameter	Type	Description
KeyName (required)	string	The name of the keypair.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteKeyPairResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeKeyPairs

POST /DescribeKeyPairs

Describes one or more of your keypairs.
You can use the Filter.N parameter to filter the described instances on the following properties:

fingerprint: The fingerprint of the keypair.
key-name: The name of the keypair.

This AWS-compliant method corresponds to ReadKeypairs in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeKeyPairs --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --KeyName '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeKeyPairs' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'KeyName.0=string'

Body (DescribeKeyPairsRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeKeyPairs \` `--Filter.1.Name "key-name" \` `--Filter.1.Value.1 "Keypair1"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
KeyName	[string]	One or more keypair names.

Response Elements

{
  "keySet": [
    {
      "keyFingerprint": "string",
      "keyName": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeKeyPairsResponse):

Response Element	Type	Description
keySet	[keySet]	Information about one or more keypairs.
keyFingerprint	string	The MD5 public key fingerprint as specified in section 4 of RFC 4716.
keyName	string	The name of the keypair.
requestId	string	The ID of the request.

ImportKeyPair

POST /ImportKeyPair

Imports a provided public key and creates a keypair.
This action imports the public key of a keypair created by a third-party tool and uses it to create a keypair. The private key is never provided to 3DS OUTSCALE.
The following types of key can be imported: RSA (2048 bits or preferably 4096 bits), Ed25519, and ECDSA (256 bits, 384 bits, or 521 bits). The following formats can be used: PEM, PKCS8, RFC4716, and OpenSSH.

This AWS-compliant method corresponds to CreateKeypair in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ImportKeyPair --profile "default" \
  --KeyName "string" \
  --PublicKeyMaterial "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ImportKeyPair' \
  --data-urlencode 'KeyName=string' \
  --data-urlencode 'PublicKeyMaterial=string'

Body (ImportKeyPairRequest):

Body Parameter	Type	Description
KeyName (required)	string	A unique name for the keypair, with a maximum length of 255 ASCII printable characters.
PublicKeyMaterial (required)	string	The public key. It must be Base64-encoded.

Response Elements

{
  "keyFingerprint": "string",
  "keyName": "string",
  "requestId": "string"
}

Response 200 (ImportKeyPairResponse):

Response Element	Type	Description
keyFingerprint	string	The MD5 public key fingerprint as specified in section 4 of RFC 4716.
keyName	string	The keypair name you specified.
requestId	string	The ID of the request.

NAT Gateways

CreateNatGateway

POST /CreateNatGateway

Creates a network address translation (NAT) gateway in the specified public subnet of a VPC.
A NAT gateway enables instances placed in private subnet of this VPC to connect to the internet, without being accessible from the internet.
When creating a NAT gateway, you specify the allocation ID of the External IP (EIP) you want to use for the NAT gateway. Once the NAT gateway is created, you need to create a route in the route table of the private subnet, with 0.0.0.0/0 as destination and the ID of the NAT gateway as target. For more information, see AssociateAddress and CreateRoute.
This action also enables you to create multiple NAT gateways in the same VPC (one per public subnet).

[IMPORTANT]
You cannot modify the EIP associated with a NAT gateway after its creation. To do so, you need to delete the NAT gateway and create a new one with another EIP.

For more information, see About NAT Services.
This AWS-compliant method corresponds to CreateNatService in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateNatGateway --profile "default" \
  --AllocationId "string" \
  --ClientToken "string" \
  --SubnetId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateNatGateway' \
  --data-urlencode 'AllocationId=string' \
  --data-urlencode 'ClientToken=string' \
  --data-urlencode 'SubnetId=string'

Body (CreateNatGatewayRequest):

Body Parameter	Type	Description
AllocationId (required)	string	The allocation ID of the EIP to associate with the NAT gateway. If the EIP is already associated with another resource, you must first disassociate it.
ClientToken	string	A unique identifier to manage the idempotency.
SubnetId (required)	string	The public subnet where you want to create the NAT gateway.

Response Elements

{
  "clientToken": "string",
  "natGateway": {
    "createTime": "string",
    "deleteTime": "string",
    "natGatewayAddressSet": [
      {
        "allocationId": "string",
        "networkInterfaceId": "string",
        "privateIp": "string",
        "publicIp": "string"
      }
    ],
    "natGatewayId": "string",
    "state": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  },
  "requestId": "string"
}

Response 200 (CreateNatGatewayResponse):

Response Element	Type	Description
clientToken	string	A unique identifier to manage the idempotency.
natGateway	natGateway	Information about the newly created NAT gateway.
createTime	string	The date and time when the NAT gateway was created.
deleteTime	string	The date and time when the NAT gateway was deleted, if applicable.
natGatewayAddressSet	[natGatewayAddressSet]	Information about the External IP (EIP) associated with the NAT gateway.
allocationId	string	The allocation ID of the External IP (EIP) associated with the NAT gateway.
networkInterfaceId	string	The ID of the network interface associated with the NAT gateway.
privateIp	string	The private IP associated with the EIP.
publicIp	string	The EIP associated with the NAT gateway.
natGatewayId	string	The ID of the NAT gateway.
state	string	The state of the NAT gateway (`pending` \| `available` \| `deleting` \| `deleted`).
subnetId	string	The ID of the public subnet in which the NAT gateway is.
tagSet	[tagSet_0]	One or more tags associated with the NAT gateway.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the VPC in which the NAT gateway is.
requestId	string	The ID of the request.

DeleteNatGateway

POST /DeleteNatGateway

Deletes a specified network address translation (NAT) gateway.
This action disassociates the External IP (EIP) from the NAT gateway, but does not release this EIP from your account. However, it does not delete any NAT gateway routes in your route tables.

This AWS-compliant method corresponds to DeleteNatService in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteNatGateway --profile "default" \
  --NatGatewayId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteNatGateway' \
  --data-urlencode 'NatGatewayId=string'

Body (DeleteNatGatewayRequest):

Body Parameter	Type	Description
NatGatewayId (required)	string	The ID of the NAT gateway.

Response Elements

{
  "natGatewayId": "string",
  "requestId": "string"
}

Response 200 (DeleteNatGatewayResponse):

Response Element	Type	Description
natGatewayId	string	The ID of the deleted NAT gateway.
requestId	string	The ID if the request.

DescribeNatGateways

POST /DescribeNatGateways

Describes one or more network address translation (NAT) gateways.
You can use the Filter.N parameter to filter the NAT gateways on the following properties:

nat-gateway-id: The ID of the NAT gateway.
state: The state of the NAT gateway (pending | available | deleting | deleted).
subnet-id: The ID of the subnet in which the NAT gateway is.
vpc-id: The ID of the VPC in which the NAT gateway is.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

This AWS-compliant method corresponds to ReadNatServices in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeNatGateways --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --MaxResults 0 \
  --NatGatewayId '["string"]' \
  --NextToken "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeNatGateways' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NatGatewayId.0=string' \
  --data-urlencode 'NextToken=string'

Body (DescribeNatGatewaysRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeNatGateways \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NatGatewayId	[string]	One or more IDs of NAT gateways.
NextToken	string	The token to request the next results page.

Response Elements

{
  "natGatewaySet": [
    {
      "createTime": "string",
      "deleteTime": "string",
      "natGatewayAddressSet": [
        {
          "allocationId": "string",
          "networkInterfaceId": "string",
          "privateIp": "string",
          "publicIp": "string"
        }
      ],
      "natGatewayId": "string",
      "state": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ],
  "nextToken": "string",
  "requestId": "string"
}

Response 200 (DescribeNatGatewaysResponse):

Response Element	Type	Description
natGatewaySet	[natGatewaySet]	Information about one or more NAT gateways.
createTime	string	The date and time when the NAT gateway was created.
deleteTime	string	The date and time when the NAT gateway was deleted, if applicable.
natGatewayAddressSet	[natGatewayAddressSet]	Information about the External IP (EIP) associated with the NAT gateway.
allocationId	string	The allocation ID of the External IP (EIP) associated with the NAT gateway.
networkInterfaceId	string	The ID of the network interface associated with the NAT gateway.
privateIp	string	The private IP associated with the EIP.
publicIp	string	The EIP associated with the NAT gateway.
natGatewayId	string	The ID of the NAT gateway.
state	string	The state of the NAT gateway (`pending` \| `available` \| `deleting` \| `deleted`).
subnetId	string	The ID of the public subnet in which the NAT gateway is.
tagSet	[tagSet_0]	One or more tags associated with the NAT gateway.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the VPC in which the NAT gateway is.
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.

Network Interfaces

AssignPrivateIpAddresses

POST /AssignPrivateIpAddresses

Assigns one or more secondary private IPs to an FNI.
This action is only available in a VPC.
The private IPs to be assigned can be added individually using the PrivateIpAddress.N parameter, or you can specify the number of private IPs to be automatically chosen within the subnet range using the SecondaryPrivateIpAddressCount parameter. You can specify only one of these two parameters. If none of these parameters are specified, a private IP is chosen within the subnet range.

This AWS-compliant method corresponds to LinkPrivateIps in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AssignPrivateIpAddresses --profile "default" \
  --AllowReassignment True \
  --NetworkInterfaceId "string" \
  --PrivateIpAddress '["string"]' \
  --SecondaryPrivateIpAddressCount 0

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AssignPrivateIpAddresses' \
  --data-urlencode 'AllowReassignment=true' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'PrivateIpAddress.0=string' \
  --data-urlencode 'SecondaryPrivateIpAddressCount=0'

Body (AssignPrivateIpAddressesRequest):

Body Parameter	Type	Description
AllowReassignment	boolean	If set to true, allows a private IP already assigned to another FNI in the same subnet to be reassigned to the specified FNI.
NetworkInterfaceId (required)	string	The ID of the FNI.
PrivateIpAddress	[string]	One or more secondary private IPs to assign to the FNI within the IP range of the subnet.
SecondaryPrivateIpAddressCount	integer	A number of secondary private IPs to assign to the FNI.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (AssignPrivateIpAddressesResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

AttachNetworkInterface

POST /AttachNetworkInterface

Attaches an FNI to an instance.
The FNI and the instance must be in the same Availability Zone (AZ). The instance can be either running or stopped. The FNI must be in the available state. For more information, see Attaching a NIC to a VM.
This AWS-compliant method corresponds to LinkNic in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AttachNetworkInterface --profile "default" \
  --DeviceIndex 0 \
  --DryRun False \
  --InstanceId "string" \
  --NetworkInterfaceId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AttachNetworkInterface' \
  --data-urlencode 'DeviceIndex=0' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'NetworkInterfaceId=string'

Body (AttachNetworkInterfaceRequest):

Body Parameter	Type	Description
DeviceIndex (required)	integer	The device index for the FNI attachment (between `1` and `7`, both included).
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
InstanceId (required)	string	The ID of the instance to which you want to attach the FNI.
NetworkInterfaceId (required)	string	The ID of the FNI to attach.

Response Elements

{
  "attachmentId": "string",
  "requestId": "string"
}

Response 200 (AttachNetworkInterfaceResponse):

Response Element	Type	Description
attachmentId	string	The ID of the attachment operation.
requestId	string	The ID of the request.

CreateNetworkInterface

POST /CreateNetworkInterface

Creates an FNI in the specified subnet.

For more information, see About NICs.
This AWS-compliant method corresponds to CreateNic in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateNetworkInterface --profile "default" \
  --Description "string" \
  --DryRun False \
  --PrivateIpAddress "string" \
  --SecurityGroupId '["string"]' \
  --SubnetId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateNetworkInterface' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'PrivateIpAddress=string' \
  --data-urlencode 'SecurityGroupId.0=string' \
  --data-urlencode 'SubnetId=string'

Body (CreateNetworkInterfaceRequest):

Body Parameter	Type	Description
Description	string	A description for the FNI. This description can contain any Unicode character, with no length limit.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
PrivateIpAddress	string	The primary private IP for the FNI. - This IP must be within the IP range of the subnet that you specified with the `subnet-id` attribute. - If you do not specify this attribute, a random private IP is selected within the IP range of the subnet.
SecurityGroupId	[string]	One or more IDs of security groups for the FNI.
SubnetId (required)	string	The ID of the subnet in which you want to create the FNI.

Response Elements

{
  "networkInterface": {
    "association": {
      "allocationId": "string",
      "associationId": "string",
      "ipOwnerId": "string",
      "publicDnsName": "string",
      "publicIp": "string"
    },
    "attachment": {
      "attachTime": "string",
      "attachmentId": "string",
      "deleteOnTermination": true,
      "deviceIndex": 0,
      "instanceId": "string",
      "instanceOwnerId": "string",
      "status": "string"
    },
    "availabilityZone": "string",
    "description": "string",
    "groupSet": [
      {
        "groupId": "string",
        "groupName": "string"
      }
    ],
    "macAddress": "string",
    "networkInterfaceId": "string",
    "ownerId": "string",
    "privateDnsName": "string",
    "privateIpAddress": "string",
    "privateIpAddressesSet": [
      {
        "association": {
          "allocationId": "string",
          "associationId": "string",
          "ipOwnerId": "string",
          "publicDnsName": "string",
          "publicIp": "string"
        },
        "primary": true,
        "privateDnsName": "string",
        "privateIpAddress": "string"
      }
    ],
    "sourceDestCheck": true,
    "status": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  },
  "requestId": "string"
}

Response 200 (CreateNetworkInterfaceResponse):

Response Element	Type	Description
networkInterface	NetworkInterface_1	Information about the newly created FNI.
association	association_0	Information about the association between the FNI and an EIP.
allocationId	string	The allocation ID returned when you allocated the EIP to your account.
associationId	string	The association ID returned when the FNI was associated with an EIP.
ipOwnerId	string	The account ID of the owner of the EIP associated with the FNI.
publicDnsName	string	The public DNS name associated with the EIP.
publicIp	string	The EIP associated with the FNI.
attachment	attachment_1	Information about the FNI attachment.
attachTime	string	The time at which the FNI was attached to an instance.
attachmentId	string	The attachment ID of the FNI.
deleteOnTermination	boolean	If true, the FNI is deleted when terminating the instance. If false, it is only detached.
deviceIndex	integer	The device index used for the FNI attachment.
instanceId	string	The ID of the instance the FNI is attached to.
instanceOwnerId	string	The account ID of the owner of the instance the FNI is attached to.
status	string	The state of the attachment.
availabilityZone	string	The AZ where the FNI is located.
description	string	The description of the FNI.
groupSet	[groupSet]	One or more security groups for the instance.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
macAddress	string	The Media Access Control (MAC) address of the FNI.
networkInterfaceId	string	The ID of the FNI.
ownerId	string	The account ID of the FNI owner.
privateDnsName	string	The private DNS name associated with the primary private IP of the FNI.
privateIpAddress	string	The primary private IP of the FNI.
privateIpAddressesSet	[privateIpAddressesSet_0]	Information about the EIP and the private IPs assigned to the FNI.
association	association_0	Information about the association between the FNI and an EIP.
allocationId	string	The allocation ID returned when you allocated the EIP to your account.
associationId	string	The association ID returned when the FNI was associated with an EIP.
ipOwnerId	string	The account ID of the owner of the EIP associated with the FNI.
publicDnsName	string	The public DNS name associated with the EIP.
publicIp	string	The EIP associated with the FNI.
primary	boolean	If true, the following private IP is the primary one. If false, it is a secondary one.
privateDnsName	string	The private DNS name associated with the primary private IP of the FNI.
privateIpAddress	string	A private IP assigned to the FNI.
sourceDestCheck	boolean	If true, the traffic to or from the instance is validated. If false, it is not.
status	string	The state of the FNI.
subnetId	string	The ID of the subnet where the FNI is located.
tagSet	[tagSet_0]	One or more tags associated with the FNI.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the VPC where the FNI is located.
requestId	string	The ID of the request.

DeleteNetworkInterface

POST /DeleteNetworkInterface

Deletes the specified FNI.
The FNI must not be attached to any instance.

This AWS-compliant method corresponds to DeleteNic in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteNetworkInterface --profile "default" \
  --DryRun False \
  --NetworkInterfaceId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteNetworkInterface' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'NetworkInterfaceId=string'

Body (DeleteNetworkInterfaceRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
NetworkInterfaceId (required)	string	The ID of the FNI.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteNetworkInterfaceResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeNetworkInterfaces

POST /DescribeNetworkInterfaces

Describes one or more Flexible Network Interface (FNI).
An FNI is a virtual network interface that you can attach to an instance in a Virtual Private Cloud (VPC).
You can use the Filter.N parameter to filter FNIs on the following properties:

addresses.private-ip-address: The private IPs associated with the FNI.
addresses.primary: Whether the private IP is the primary IP associated with the FNI.
addresses.association.public-ip: The association ID returned when the FNI was associated with an External IP (EIP).
addresses.association.owner-id: The account ID of the owner of the IPs associated with the FNI.
association.association-id: The association ID returned when the FNI was associated with an EIP.
association.allocation-id: The allocation ID returned when you allocated the EIP to your account.
association.ip-owner-id: The account ID of the owner of the EIP associated with the FNI.
association.public-ip: The EIP associated with the FNI.
association.public-dns-name: The public DNS name associated with the EIP.
attachment.attachment-id: The attachment ID of the FNI.
attachment.instance-id: The ID of the instance the FNI is attached to.
attachment.instance-owner-id: The account ID of the owner of the instance the FNI is attached to.
attachment.device-index: The device index used for the FNI.
attachment.status: The state of the attachment.
attachment.attach-time: The time at which the FNI was attached to an instance.
attachment.delete-on-termination: Whether the FNI is deleted when the instance it is attached to is terminated.
availability-zone: The Availability Zone (AZ) where the FNI is located.
description: The description of the FNI.
group-id: The ID of a security group associated with the FNI.
group-name: The name of a security group associated with the FNI.
mac-address: The Media Access Control (MAC) address of the FNI.
network-interface-id: The ID of the FNI.
owner-id: The account ID of the FNI owner.
private-ip-address: The primary private IP of the FNI.
private-dns-name: The private DNS name associated with the primary private IP.
source-dest-check: Whether the source/destination checking is enabled (true) or disabled (false).
status: The state of the FNI.
subnet-id: The ID of the subnet in where the FNI is located.
vpc-id: The ID of the VPC in where the FNI is located.

This AWS-compliant method corresponds to ReadNics in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeNetworkInterfaces --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --NetworkInterfaceId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeNetworkInterfaces' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'NetworkInterfaceId.0=string'

Body (DescribeNetworkInterfacesRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeNetworkInterfaces \` `--Filter.1.Name "network-interface-id" \` `--Filter.1.Value.1 "eni-12345678"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
NetworkInterfaceId	[string]	One or more FNI IDs.

Response Elements

{
  "networkInterfaceSet": [
    {
      "association": {
        "allocationId": "string",
        "associationId": "string",
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "attachment": {
        "attachTime": "string",
        "attachmentId": "string",
        "deleteOnTermination": true,
        "deviceIndex": 0,
        "instanceId": "string",
        "instanceOwnerId": "string",
        "status": "string"
      },
      "availabilityZone": "string",
      "description": "string",
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "macAddress": "string",
      "networkInterfaceId": "string",
      "ownerId": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "privateIpAddressesSet": [
        {
          "association": {
            "allocationId": "string",
            "associationId": "string",
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "primary": true,
          "privateDnsName": "string",
          "privateIpAddress": "string"
        }
      ],
      "sourceDestCheck": true,
      "status": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeNetworkInterfacesResponse):

Response Element	Type	Description
networkInterfaceSet	[networkInterfaceSet_1]	Information about the FNIs.
association	association_0	Information about the association between the FNI and an EIP.
allocationId	string	The allocation ID returned when you allocated the EIP to your account.
associationId	string	The association ID returned when the FNI was associated with an EIP.
ipOwnerId	string	The account ID of the owner of the EIP associated with the FNI.
publicDnsName	string	The public DNS name associated with the EIP.
publicIp	string	The EIP associated with the FNI.
attachment	attachment_1	Information about the FNI attachment.
attachTime	string	The time at which the FNI was attached to an instance.
attachmentId	string	The attachment ID of the FNI.
deleteOnTermination	boolean	If true, the FNI is deleted when terminating the instance. If false, it is only detached.
deviceIndex	integer	The device index used for the FNI attachment.
instanceId	string	The ID of the instance the FNI is attached to.
instanceOwnerId	string	The account ID of the owner of the instance the FNI is attached to.
status	string	The state of the attachment.
availabilityZone	string	The AZ where the FNI is located.
description	string	The description of the FNI.
groupSet	[groupSet]	One or more security groups for the FNI.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
macAddress	string	The Media Access Control (MAC) address of the FNI.
networkInterfaceId	string	The ID of the FNI.
ownerId	string	The account ID of the FNI owner.
privateDnsName	string	The private DNS name associated with the primary private IP of the FNI.
privateIpAddress	string	The primary private IP of the FNI.
privateIpAddressesSet	[privateIpAddressesSet_0]	Information about the EIP and the private IPs assigned to the FNI.
association	association_0	Information about the association between the FNI and an EIP.
allocationId	string	The allocation ID returned when you allocated the EIP to your account.
associationId	string	The association ID returned when the FNI was associated with an EIP.
ipOwnerId	string	The account ID of the owner of the EIP associated with the FNI.
publicDnsName	string	The public DNS name associated with the EIP.
publicIp	string	The EIP associated with the FNI.
primary	boolean	If true, the following private IP is the primary one. If false, it is a secondary one.
privateDnsName	string	The private DNS name associated with the primary private IP of the FNI.
privateIpAddress	string	A private IP assigned to the FNI.
sourceDestCheck	boolean	If true, the traffic to or from the instance is validated. If false, it is not.
status	string	The state of the FNI.
subnetId	string	The ID of the subnet where the FNI is located.
tagSet	[tagSet_0]	One or more tags associated with the FNI.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the VPC where the FNI is located.
requestId	string	The ID of the request.

DetachNetworkInterface

POST /DetachNetworkInterface

Detaches an FNI from an instance.
The primary FNI cannot be detached.

This AWS-compliant method corresponds to UnlinkNic in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DetachNetworkInterface --profile "default" \
  --AttachmentId "string" \
  --DryRun False

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DetachNetworkInterface' \
  --data-urlencode 'AttachmentId=string' \
  --data-urlencode 'DryRun=false'

Body (DetachNetworkInterfaceRequest):

Body Parameter	Type	Description
AttachmentId (required)	string	The ID of the attachment operation.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DetachNetworkInterfaceResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

ModifyNetworkInterfaceAttribute

POST /ModifyNetworkInterfaceAttribute

Modifies the specified FNI Interfaces attribute. You can specify only one attribute at a time.

This AWS-compliant method corresponds to UpdateNic in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ModifyNetworkInterfaceAttribute --profile "default" \
  --Attachment '{
      "AttachmentId": "string",
      "DeleteOnTermination": True
    }' \
  --Description '{
      "Value": "string"
    }' \
  --DryRun False \
  --NetworkInterfaceId "string" \
  --SecurityGroupId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyNetworkInterfaceAttribute' \
  --data-urlencode 'Attachment.AttachmentId=string' \
  --data-urlencode 'Attachment.DeleteOnTermination=true' \
  --data-urlencode 'Description.Value=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'SecurityGroupId.0=string'

Body (ModifyNetworkInterfaceAttributeRequest):

Body Parameter	Type	Description
Attachment	Attachment	A new configuration for the attachment.
AttachmentId	string	The ID of the FNI attachment.
DeleteOnTermination	boolean	By default or if set to false, the FNI is detached from the instance when the instance is terminated. If true, the FNI is deleted.
Description	Description_0	A new description of the resource.
Value	string	The value specified for the resource attribute.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
NetworkInterfaceId (required)	string	The ID of the FNI.
SecurityGroupId	[string]	One or more IDs of security groups to associate with the FNI. The FNI must be associated with at least one security group.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (ModifyNetworkInterfaceAttributeResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

UnassignPrivateIpAddresses

POST /UnassignPrivateIpAddresses

Unassigns one or more secondary private IPs from an FNI.

This AWS-compliant method corresponds to UnlinkPrivateIps in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu UnassignPrivateIpAddresses --profile "default" \
  --NetworkInterfaceId "string" \
  --PrivateIpAddress '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=UnassignPrivateIpAddresses' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'PrivateIpAddress.0=string'

Body (UnassignPrivateIpAddressesRequest):

Body Parameter	Type	Description
NetworkInterfaceId (required)	string	The ID of the FNI.
PrivateIpAddress (required)	[string]	One or more secondary private IPs you want to unassign from the FNI.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (UnassignPrivateIpAddressesResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

Peering Connections

AcceptVpcPeeringConnection

POST /AcceptVpcPeeringConnection

Accepts a VPC peering connection request.
To accept this request, you must be the owner of the peer VPC. If you do not accept the request within 7 days, the state of the VPC peering connection becomes expired.

[NOTE]
A peering connection between two VPCs works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant.

This AWS-compliant method corresponds to AcceptNetPeering in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AcceptVpcPeeringConnection --profile "default" \
  --VpcPeeringConnectionId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AcceptVpcPeeringConnection' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Body (AcceptVpcPeeringConnectionRequest):

Body Parameter	Type	Description
VpcPeeringConnectionId (required)	string	The ID of the VPC peering connection you want to accept.

Response Elements

{
  "requestId": "string",
  "vpcPeeringConnection": {
    "accepterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "expirationTime": "string",
    "requesterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "status": {
      "code": "string",
      "message": "string"
    },
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcPeeringConnectionId": "string"
  }
}

Response 200 (AcceptVpcPeeringConnectionResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpcPeeringConnection	vpcPeeringConnection	Information about the created VPC peering connection.
accepterVpcInfo	accepterVpcInfo	Information about the peer VPC of the VPC peering connection.
cidrBlock	string	The CIDR block of the VPC.
ownerId	string	The account ID of the owner of the VPC.
vpcId	string	The ID of the VPC.
expirationTime	string	The time after which a VPC peering connection request in the `pending-acceptance` state expires.
requesterVpcInfo	requesterVpcInfo	Information about the source VPC of the VPC peering connection.
cidrBlock	string	The CIDR block of the VPC.
ownerId	string	The account ID of the owner of the VPC.
vpcId	string	The ID of the VPC.
status	status	The state of the VPC peering connection.
code	string	The state of the VPC peering connection (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
message	string	Additional information about the state of the VPC peering connection.
tagSet	[tagSet_0]	One or more tags associated with the VPC peering connection.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcPeeringConnectionId	string	The ID of the VPC peering connection.

CreateVpcPeeringConnection

POST /CreateVpcPeeringConnection

Requests a VPC peering connection between a VPC you own and a peer VPC that belongs to you or another account.
This action creates a VPC peering connection that remains in the pending-acceptance state until it is accepted by the owner of the peer VPC. If the owner of the peer VPC does not accept the request within 7 days, the state of the VPC peering connection becomes expired. For more information, see AcceptVpcPeeringConnection.

[IMPORTANT]

Peered VPCs must contain at least one instance each before the creation of the VPC peering connection.
The two VPCs must not have overlapping CIDR blocks. Otherwise, the VPC peering connection is in the failed state.
A peering connection between two VPCs works both ways. Therefore, you do not need to create a B-to-A connection if an A-to-B connection is created and accepted.

For more information, see About Net Peerings.
This AWS-compliant method corresponds to CreateNetPeering in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateVpcPeeringConnection --profile "default" \
  --PeerOwnerId "string" \
  --PeerVpcId "string" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpcPeeringConnection' \
  --data-urlencode 'PeerOwnerId=string' \
  --data-urlencode 'PeerVpcId=string' \
  --data-urlencode 'VpcId=string'

Body (CreateVpcPeeringConnectionRequest):

Body Parameter	Type	Description
PeerOwnerId	string	The account ID of the owner of the VPC you want to connect with. By default, it is your account ID.
PeerVpcId (required)	string	The ID of the VPC you want to connect with.
VpcId (required)	string	The ID of the VPC you send the request from.

Response Elements

{
  "requestId": "string",
  "vpcPeeringConnection": {
    "accepterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "expirationTime": "string",
    "requesterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "status": {
      "code": "string",
      "message": "string"
    },
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcPeeringConnectionId": "string"
  }
}

Response 200 (CreateVpcPeeringConnectionResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpcPeeringConnection	vpcPeeringConnection	Information about the created VPC peering connection.
accepterVpcInfo	accepterVpcInfo	Information about the peer VPC of the VPC peering connection.
cidrBlock	string	The CIDR block of the VPC.
ownerId	string	The account ID of the owner of the VPC.
vpcId	string	The ID of the VPC.
expirationTime	string	The time after which a VPC peering connection request in the `pending-acceptance` state expires.
requesterVpcInfo	requesterVpcInfo	Information about the source VPC of the VPC peering connection.
cidrBlock	string	The CIDR block of the VPC.
ownerId	string	The account ID of the owner of the VPC.
vpcId	string	The ID of the VPC.
status	status	The state of the VPC peering connection.
code	string	The state of the VPC peering connection (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
message	string	Additional information about the state of the VPC peering connection.
tagSet	[tagSet_0]	One or more tags associated with the VPC peering connection.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcPeeringConnectionId	string	The ID of the VPC peering connection.

DeleteVpcPeeringConnection

POST /DeleteVpcPeeringConnection

Deletes a VPC peering connection.
If the VPC peering connection is in the active state, it can be deleted either by the owner of the requester VPC or the owner of the peer VPC.
If it is in the pending-acceptance state, it can be deleted only by the owner of the requester VPC.
If it is in the rejected, failed, or expired states, it cannot be deleted.

This AWS-compliant method corresponds to DeleteNetPeering in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteVpcPeeringConnection --profile "default" \
  --VpcPeeringConnectionId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpcPeeringConnection' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Body (DeleteVpcPeeringConnectionRequest):

Body Parameter	Type	Description
VpcPeeringConnectionId (required)	string	The ID of the VPC peering connection you want to delete.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteVpcPeeringConnectionResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeVpcPeeringConnections

POST /DescribeVpcPeeringConnections

Describes one or more peering connections between two Virtual Private Clouds (VPCs).
You can use the Filter.N parameter to filter the described VPC peering connections on the following properties:

accepter-vpc-info.cidr-block: The CIDR block of the peer VPC.
accepter-vpc-info.owner-id: The account ID of the owner of the peer VPC.
accepter-vpc-info.vpc-id: The ID of the peer VPC.
expiration-time: The date after which the connection expires.
requester-vpc-info.cidr-block: The CIDR block of the requester VPC.
requester-vpc-info.owner-id: The ID of the owner of the requester VPC.
requester-vpc-info.vpc-id: The ID of the requester VPC.
status-code: The state of the VPC peering connection (pending-acceptance | active | rejected | failed | expired | deleted).
status-message: Additional information about the state of the VPC peering connection.
vpc-peering-connection-id: The ID of the VPC peering connection.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

This AWS-compliant method corresponds to ReadNetPeerings in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeVpcPeeringConnections --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --VpcPeeringConnectionId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcPeeringConnections' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'VpcPeeringConnectionId.0=string'

Body (DescribeVpcPeeringConnectionsRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpcPeeringConnections \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
VpcPeeringConnectionId	[string]	One or more VPC peering connection IDs.

Response Elements

{
  "requestId": "string",
  "vpcPeeringConnectionSet": [
    {
      "accepterVpcInfo": {
        "cidrBlock": "string",
        "ownerId": "string",
        "vpcId": "string"
      },
      "expirationTime": "string",
      "requesterVpcInfo": {
        "cidrBlock": "string",
        "ownerId": "string",
        "vpcId": "string"
      },
      "status": {
        "code": "string",
        "message": "string"
      },
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcPeeringConnectionId": "string"
    }
  ]
}

Response 200 (DescribeVpcPeeringConnectionsResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpcPeeringConnectionSet	[vpcPeeringConnectionSet]	Information about one or more VPC peering connections.
accepterVpcInfo	accepterVpcInfo	Information about the peer VPC of the VPC peering connection.
cidrBlock	string	The CIDR block of the VPC.
ownerId	string	The account ID of the owner of the VPC.
vpcId	string	The ID of the VPC.
expirationTime	string	The time after which a VPC peering connection request in the `pending-acceptance` state expires.
requesterVpcInfo	requesterVpcInfo	Information about the source VPC of the VPC peering connection.
cidrBlock	string	The CIDR block of the VPC.
ownerId	string	The account ID of the owner of the VPC.
vpcId	string	The ID of the VPC.
status	status	The state of the VPC peering connection.
code	string	The state of the VPC peering connection (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
message	string	Additional information about the state of the VPC peering connection.
tagSet	[tagSet_0]	One or more tags associated with the VPC peering connection.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcPeeringConnectionId	string	The ID of the VPC peering connection.

RejectVpcPeeringConnection

POST /RejectVpcPeeringConnection

Rejects a VPC peering connection request.
The VPC peering connection must be in the pending-acceptance state to be rejected. The rejected VPC peering connection is then in the rejected state.

This AWS-compliant method corresponds to RejectNetPeering in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu RejectVpcPeeringConnection --profile "default" \
  --VpcPeeringConnectionId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RejectVpcPeeringConnection' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Body (RejectVpcPeeringConnectionRequest):

Body Parameter	Type	Description
VpcPeeringConnectionId (required)	string	The ID of the VPC peering connection you want to reject.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (RejectVpcPeeringConnectionResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

Prefix Lists

DescribePrefixLists

POST /DescribePrefixLists

Describes one or more prefix lists for available OUTSCALE services.
Each prefix list is composed of an ID, a name to identify the service it is associated with and a list of network prefixes used by this service, in CIDR notation.
You can use prefix list IDs in outbound security group rules to allow traffic from a VPC to access the corresponding service. For more information, see the AuthorizeSecurityGroupEgress method.
You can filter the described prefix lists using the PrefixListId.N parameter.
You can also use the Filter.N parameter to filter the prefix lists on the following properties:

prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.

This AWS-compliant method corresponds to ReadNetAccessPointServices in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribePrefixLists --profile "default" \
  --DryRun False \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --MaxResults 0 \
  --NextToken "string" \
  --PrefixListId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribePrefixLists' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string' \
  --data-urlencode 'PrefixListId.0=string'

Body (DescribePrefixListsRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribePrefixLists \` `--Filter.1.Name "prefix-list-id" \` `--Filter.1.Value.1 "pl-12345678"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use `NextToken` to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NextToken	string	The token to request the next results page.
PrefixListId	[string]	One or more prefix list IDs.

Response Elements

{
  "nextToken": "string",
  "prefixListSet": [
    {
      "cidrSet": [
        "string"
      ],
      "prefixListId": "string",
      "prefixListName": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribePrefixListsResponse):

Response Element	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
prefixListSet	[prefixListSet]	Information about one or more prefix lists.
cidrSet	[string]	The list of network prefixes used by the service, in CIDR notation.
prefixListId	string	The ID of the prefix list.
prefixListName	string	The name of the prefix list, which identifies the OUTSCALE service it is associated with.
requestId	string	The ID of the request.

Product Types

DescribeInstanceTypes

POST /DescribeInstanceTypes

Describes one or more predefined instance types.

You can use the Filter.N parameter to filter the instance types on the following properties:

ephemerals-type: The type of ephemeral storage disk.
eth: The number of Ethernet interfaces available.
gpu: The number of GPUs available.
memory: The amount of memory, in bytes.
name: The name of the instance type.
storage-count: The maximum number of ephemeral storage disks.
storage-size: The size of one ephemeral storage disk, in bytes.
vcpu: The number of vCPUs.

This AWS-compliant method corresponds to ReadVmTypes in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeInstanceTypes --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeInstanceTypes' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string'

Body (DescribeInstanceTypesRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeInstanceTypes \` `--Filter.1.Name "description" \` `--Filter.1.Value.1 "Windows"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.

Response Elements

{
  "instanceTypeSet": [
    {
      "ebsOptimizedAvailable": true,
      "ephemeralsType": "string",
      "eth": 0,
      "gpu": 0,
      "maxIpAddresses": 0,
      "memory": 0,
      "name": "string",
      "storageCount": 0,
      "storageSize": 0,
      "vcpu": 0
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeInstanceTypesResponse):

Response Element	Type	Description
instanceTypeSet	[instanceTypeSet]	One or more instance types.
ebsOptimizedAvailable	boolean	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
ephemeralsType	string	The type of ephemeral storage disk.
eth	integer	The number of Ethernet interfaces available.
gpu	integer	The number of GPUs available.
maxIpAddresses	integer	The maximum number of private IPs per network interface.
memory	integer	The amount of memory, in bytes.
name	string	The name of the instance type.
storageCount	integer	The maximum number of ephemeral storage disks.
storageSize	integer	The size of one ephemeral storage disk, in bytes.
vcpu	integer	The number of vCPUs.
requestId	string	The ID of the request.

DescribeProductTypes

POST /DescribeProductTypes

Describes one or more product types.
You can use the Filter.N parameter to filter the product types on the description property:

description: The description of the product.

This AWS-compliant method corresponds to ReadProductTypes in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeProductTypes --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeProductTypes' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string'

Body (DescribeProductTypesRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeProductTypes \` `--Filter.1.Name "description" \` `--Filter.1.Value.1 "Windows"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.

Response Elements

{
  "productTypeSet": [
    {
      "description": "string",
      "productTypeId": "string",
      "vendor": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeProductTypesResponse):

Response Element	Type	Description
productTypeSet	[productTypeSet]	One or more product types.
description	string	The description of the product type.
productTypeId	string	The ID of the product type.
vendor	string	The vendor of the product type.
requestId	string	The ID of the request.

GetProductType

POST /GetProductType

Gets the product type of a specified OUTSCALE machine image (OMI) or snapshot.

[TIP]
This function is deprecated. Use the GetProductTypes method instead to get the product type of all products installed on an OMI or snapshot.

This AWS-compliant method corresponds to ReadSnapshots in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu GetProductType --profile "default" \
  --ImageId "string" \
  --SnapshotId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=GetProductType' \
  --data-urlencode 'ImageId=string' \
  --data-urlencode 'SnapshotId=string'

Body (GetProductTypeRequest):

Body Parameter	Type	Description
ImageId	string	The ID of the OMI.
SnapshotId	string	The ID of the snapshot.

Response Elements

{
  "productType": {
    "description": "string",
    "productTypeId": "string",
    "vendor": "string"
  },
  "requestId": "string"
}

Response 200 (GetProductTypeResponse):

Response Element	Type	Description
productType	productType	Information about the product type of the specified OMI or snapshot.
description	string	The description of the product type.
productTypeId	string	The ID of the product type.
vendor	string	The vendor of the product type.
requestId	string	The ID of the request.

GetProductTypes

POST /GetProductTypes

Gets the product types of all products installed on a specified OUTSCALE machine image (OMI) or snapshot.

This AWS-compliant method corresponds to ReadSnapshots in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu GetProductTypes --profile "default" \
  --ImageId "string" \
  --SnapshotId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=GetProductTypes' \
  --data-urlencode 'ImageId=string' \
  --data-urlencode 'SnapshotId=string'

Body (GetProductTypesRequest):

Body Parameter	Type	Description
ImageId	string	The ID of the OMI.
SnapshotId	string	The ID of the snapshot.

Response Elements

{
  "productTypeSet": [
    {
      "description": "string",
      "productTypeId": "string",
      "vendor": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (GetProductTypesResponse):

Response Element	Type	Description
productTypeSet	[productTypeSet]	Information about one or more product types.
description	string	The description of the product type.
productTypeId	string	The ID of the product type.
vendor	string	The vendor of the product type.
requestId	string	The ID of the request.

Quotas

DescribeQuotas

POST /DescribeQuotas

Describes one or more of your quotas.
You can use the QuotaName.N parameter to filter on the name of one or more quotas.
You can also use the Filter.N parameter to filter the described quotas on the following properties:

reference: The reference of the quota.
quota.display-name: The display name of the quota.
quota.group-name: The group name of the quota.

For more information, see About Your Accounts.
This AWS-compliant method corresponds to ReadQuotas in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeQuotas --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --MaxResults 0 \
  --NextToken "string" \
  --QuotaName '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeQuotas' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string' \
  --data-urlencode 'QuotaName.0=string'

Body (DescribeQuotasRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeQuotas \` `--Filter.1.Name "quota.display-name" \` `--Filter.1.Value.1 "DisplayName"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
MaxResults	integer	The maximum number of items that can be returned in a single page (by default, `100`).
NextToken	string	The token to request the next results page.
QuotaName	[string]	One or more names of quotas.

Response Elements

{
  "nextToken": "string",
  "referenceQuotaSet": [
    {
      "quotaSet": [
        {
          "description": "string",
          "displayName": "string",
          "groupName": "string",
          "maxQuotaValue": 0,
          "name": "string",
          "ownerId": "string",
          "usedQuotaValue": 0
        }
      ],
      "reference": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeQuotasResponse):

Response Element	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there are no results left to be returned.
referenceQuotaSet	[referenceQuotaSet]	One or more reference quotas.
quotaSet	[QuotaSet]	One or more quotas associated with the account.
description	string	The description of the quota.
displayName	string	The display name of the quota.
groupName	string	The group name the quota belongs to.
maxQuotaValue	integer	The maximum value of the quota for the account (if there is no limit, `0`).
name	string	The unique name of the quota.
ownerId	string	The account ID of owner of the quota.
usedQuotaValue	integer	The limit value currently used by the account.
reference	string	The resource ID if it is a resource-specific quota, `global` if it is not.
requestId	string	The ID of the request.

Regions

DescribeAvailabilityZones

POST /DescribeAvailabilityZones

Describes one or more of the enabled Availability Zones that you can access in the current Region.
You can use the ZoneName.N parameter to filter on the name of one or more Availability Zones.
You can also use the Filter.N parameter to filter the described Availability Zones on the following properties:

region-name: The name of the Region containing the Availability Zones.
state: The state of the Availability Zone.
zone-name: The name of the Availability Zone. This filter is similar to the ZoneName.N parameter.

[IMPORTANT]
You can only use this command to get information about Availability Zones in a Region for which you have an account. Otherwise, the AuthFailure error message is returned.

This AWS-compliant method corresponds to ReadSubregions in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeAvailabilityZones --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --ZoneName '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeAvailabilityZones' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'ZoneName.0=string'

Body (DescribeAvailabilityZonesRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeAvailabilityZones \` `--Filter.1.Name "state" \` `--Filter.1.Value.1 "available"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
ZoneName	[string]	Information about one or more Availability Zones.

Response Elements

{
  "availabilityZoneInfo": [
    {
      "regionName": "string",
      "zoneName": "string",
      "zoneState": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeAvailabilityZonesResponse):

Response Element	Type	Description
availabilityZoneInfo	[availabilityZoneInfo]	Information about the Availability Zones.
regionName	string	The name of the Region containing the Availability Zone.
zoneName	string	The name of the Availability Zone.
zoneState	string	The state of the Availability Zone.
requestId	string	The ID of the request.

DescribeRegions

POST /DescribeRegions

Describes one or more Regions of the OUTSCALE Cloud.
You can use the RegionName.N parameter to filter on the name of one or more Regions.
You can also use the Filter.N parameter to filter the described Regions on the following properties:

region-name: The name of the Region. This filter is similar to the RegionName.N parameter.
endpoint: The complete URL of the gateway to access the Region.

For more information, see About Regions and Subregions.
This AWS-compliant method corresponds to ReadRegions in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeRegions --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --RegionName '["string"]'

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeRegions' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'RegionName.0=string'

Body (DescribeRegionsRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeRegions \` `--Filter.1.Name "region-name" \` `--Filter.1.Value.1 "eu-west-2"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
RegionName	[string]	The name of one or more Regions.

Response Elements

{
  "regionInfo": [
    {
      "regionEndpoint": "string",
      "regionName": "string"
    }
  ],
  "requestId": "string"
}

Response 200 (DescribeRegionsResponse):

Response Element	Type	Description
regionInfo	[regionInfo]	Information about one or more Regions.
regionEndpoint	string	The hostname of the gateway to access the Region.
regionName	string	The administrative name of the Region.
requestId	string	The ID of the request.

ReadPublicIpRanges

POST /ReadPublicIpRanges

Returns the public IPv4 addresses in CIDR notation for the Region specified in the endpoint of the request. For more information, see About Regions and Subregions.
This AWS-compliant method corresponds to ReadPublicIpRanges in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ReadPublicIpRanges --profile "default"

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ReadPublicIpRanges'

Body (ReadPublicIpRangesRequest):

Body Parameter	Type	Description

Response Elements

{
  "publicIpSet": [
    "string"
  ],
  "requestId": "string"
}

Response 200 (ReadPublicIpRangesResponse):

Response Element	Type	Description
publicIpSet	[string]	The list of public IPv4 addresses used in the Region, in CIDR notation.
requestId	string	The ID of the request.

Route Tables

AssociateRouteTable

POST /AssociateRouteTable

Associates a subnet with a route table.
The subnet and the route table must be in the same VPC. The traffic is routed according to the route table defined within this VPC. You can associate a route table with several subnets.

This AWS-compliant method corresponds to LinkRouteTable in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AssociateRouteTable --profile "default" \
  --RouteTableId "string" \
  --SubnetId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AssociateRouteTable' \
  --data-urlencode 'RouteTableId=string' \
  --data-urlencode 'SubnetId=string'

Body (AssociateRouteTableRequest):

Body Parameter	Type	Description
RouteTableId (required)	string	The ID of the route table.
SubnetId (required)	string	The ID of the subnet.

Response Elements

{
  "associationId": "string",
  "requestId": "string"
}

Response 200 (AssociateRouteTableResponse):

Response Element	Type	Description
associationId	string	The ID of the route table association.
requestId	string	The ID of the request.

CreateRoute

POST /CreateRoute

Creates a route in a specified route table within a specified VPC.
You must specify one of the following elements as the target:

VPC peering connection
NAT instance
Internet gateway
Virtual private gateway
NAT gateway
Network interface
The routing algorithm is based on the most specific match.

For more information, see About Route Tables.
This AWS-compliant method corresponds to CreateRoute in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --GatewayId "string" \
  --InstanceId "string" \
  --NatGatewayId "string" \
  --NetworkInterfaceId "string" \
  --RouteTableId "string" \
  --VpcPeeringConnectionId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'GatewayId=string' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'NatGatewayId=string' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'RouteTableId=string' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Body (CreateRouteRequest):

Body Parameter	Type	Description
DestinationCidrBlock (required)	string	The CIDR block used for the destination match.
GatewayId	string	The ID of an internet gateway or virtual private gateway attached to your VPC.
InstanceId	string	The ID of a NAT instance in your VPC (attached to exactly one network interface).
NatGatewayId	string	The ID of a NAT gateway.
NetworkInterfaceId	string	The ID of a network interface.
RouteTableId (required)	string	The ID of the route table.
VpcPeeringConnectionId	string	The ID of a VPC peering connection.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (CreateRouteResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

CreateRouteTable

POST /CreateRouteTable

Creates a route table for a specified VPC.
You can then add routes and associate this route table with a subnet.

For more information, see About Route Tables.
This AWS-compliant method corresponds to CreateRouteTable in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateRouteTable --profile "default" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateRouteTable' \
  --data-urlencode 'VpcId=string'

Body (CreateRouteTableRequest):

Body Parameter	Type	Description
VpcId (required)	string	The ID of the VPC.

Response Elements

{
  "requestId": "string",
  "routeTable": {
    "associationSet": [
      {
        "main": true,
        "routeTableAssociationId": "string",
        "routeTableId": "string",
        "subnetId": "string"
      }
    ],
    "propagatingVgwSet": [
      {
        "gatewayId": "string"
      }
    ],
    "routeSet": [
      {
        "destinationCidrBlock": "string",
        "destinationPrefixListId": "string",
        "gatewayId": "string",
        "instanceId": "string",
        "instanceOwnerId": "string",
        "networkInterfaceId": "string",
        "origin": "string",
        "state": "string",
        "vpcPeeringConnectionId": "string"
      }
    ],
    "routeTableId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

Response 200 (CreateRouteTableResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
routeTable	routeTable	Information about the newly created route table.
associationSet	[associationSet]	One or more associations between the route table and the subnets.
main	boolean	If true, the route table is the main one.
routeTableAssociationId	string	The ID of the association between a route table and a subnet.
routeTableId	string	The ID of the route table.
subnetId	string	The ID of the subnet.
propagatingVgwSet	[propagatingVgwSet]	Information about virtual private gateways propagating routes.
gatewayId	string	The ID of the virtual private gateway.
routeSet	[routeSet]	One or more routes in the route table.
destinationCidrBlock	string	The CIDR block used to match the destination.
destinationPrefixListId	string	The prefix of the OUTSCALE service.
gatewayId	string	The ID of a gateway attached to the VPC.
instanceId	string	The ID of a NAT instance in your VPC.
instanceOwnerId	string	The account ID of the owner of the instance.
networkInterfaceId	string	The ID of the network interface.
origin	string	The method used to create the route.
state	string	The state of the route.
vpcPeeringConnectionId	string	The ID of the VPC peering connection.
routeTableId	string	The ID of the route table.
tagSet	[tagSet_0]	One or more tags associated with the route table.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the VPC.

DeleteRoute

POST /DeleteRoute

Deletes a route from a specified route table.

This AWS-compliant method corresponds to DeleteRoute in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --RouteTableId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'RouteTableId=string'

Body (DeleteRouteRequest):

Body Parameter	Type	Description
DestinationCidrBlock (required)	string	The exact CIDR range for the route.
RouteTableId (required)	string	The ID of the route table you want to delete.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteRouteResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DeleteRouteTable

POST /DeleteRouteTable

Deletes a specified route table.
Before deleting a route table, you must disassociate it from any subnet. You cannot delete the main route table.

This AWS-compliant method corresponds to DeleteRouteTable in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteRouteTable --profile "default" \
  --RouteTableId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteRouteTable' \
  --data-urlencode 'RouteTableId=string'

Body (DeleteRouteTableRequest):

Body Parameter	Type	Description
RouteTableId (required)	string	The ID of the route table.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteRouteTableResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeRouteTables

POST /DescribeRouteTables

Describes one or more of your route tables.
In your Virtual Private Cloud (VPC), each subnet must be associated with a route table. If a subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the VPC.
You can use the Filter.N parameter to filter the route tables on the following properties:

association.route-table-association-id: The ID of an association ID for the route table.
association.route-table-id: The ID of the route table involved in the association.
association.subnet-id: The ID of the subnet involved in the association.
association.main: Indicates whether the route table is the main route table for the VPC (true | false).
route-table-id: The ID of the route table.
route.destination-cidr-block: The CIDR range specified in a route in the table.
route.destination-prefix-list-id: The prefix ID of the service specified in a route in the table.
route.gateway-id: The ID of a gateway specified in a route in the table.
route.instance-id: The ID of an instance specified in a route in the table.
route.nat-gateway-id: The ID of a NAT gateway specified in a route in the table.
route.origin: How the route was created.
route.state: The state of a route in the route table (always active).
route.vpc-peering-connection-id: The ID of a VPC peering connection specified in a route in the table.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.
vpc-id: The ID of the VPC for the route table.

This AWS-compliant method corresponds to ReadRouteTables in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeRouteTables --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --RouteTableId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeRouteTables' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'RouteTableId.0=string'

Body (DescribeRouteTablesRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeRouteTables \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
RouteTableId	[string]	One or more route table IDs.

Response Elements

{
  "requestId": "string",
  "routeTableSet": [
    {
      "associationSet": [
        {
          "main": true,
          "routeTableAssociationId": "string",
          "routeTableId": "string",
          "subnetId": "string"
        }
      ],
      "propagatingVgwSet": [
        {
          "gatewayId": "string"
        }
      ],
      "routeSet": [
        {
          "destinationCidrBlock": "string",
          "destinationPrefixListId": "string",
          "gatewayId": "string",
          "instanceId": "string",
          "instanceOwnerId": "string",
          "networkInterfaceId": "string",
          "origin": "string",
          "state": "string",
          "vpcPeeringConnectionId": "string"
        }
      ],
      "routeTableId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

Response 200 (DescribeRouteTablesResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
routeTableSet	[routeTableSet]	Information about one or more route tables.
associationSet	[associationSet]	One or more associations between the route table and the subnets.
main	boolean	If true, the route table is the main one.
routeTableAssociationId	string	The ID of the association between a route table and a subnet.
routeTableId	string	The ID of the route table.
subnetId	string	The ID of the subnet.
propagatingVgwSet	[propagatingVgwSet]	Information about virtual private gateways propagating routes.
gatewayId	string	The ID of the virtual private gateway.
routeSet	[routeSet]	One or more routes in the route table.
destinationCidrBlock	string	The CIDR block used to match the destination.
destinationPrefixListId	string	The prefix of the OUTSCALE service.
gatewayId	string	The ID of a gateway attached to the VPC.
instanceId	string	The ID of a NAT instance in your VPC.
instanceOwnerId	string	The account ID of the owner of the instance.
networkInterfaceId	string	The ID of the network interface.
origin	string	The method used to create the route.
state	string	The state of the route.
vpcPeeringConnectionId	string	The ID of the VPC peering connection.
routeTableId	string	The ID of the route table.
tagSet	[tagSet_0]	One or more tags associated with the route table.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the VPC.

DisassociateRouteTable

POST /DisassociateRouteTable

Disassociates a subnet from a route table.
After disassociation, the subnet can no longer use the routes in this route table, but uses the routes in the main route table of the VPC instead.

This AWS-compliant method corresponds to UnlinkRouteTable in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DisassociateRouteTable --profile "default" \
  --AssociationId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DisassociateRouteTable' \
  --data-urlencode 'AssociationId=string'

Body (DisassociateRouteTableRequest):

Body Parameter	Type	Description
AssociationId (required)	string	The ID of the current association between the route table and the subnet.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DisassociateRouteTableResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

ReplaceRoute

POST /ReplaceRoute

Replaces an existing route within a route table in a VPC.
You must specify one of the following elements as the target:

VPC peering connection
NAT instance
Internet gateway
Virtual private gateway
NAT gateway
Network interface
The routing algorithm is based on the most specific match.

This AWS-compliant method corresponds to UpdateRoute in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ReplaceRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --GatewayId "string" \
  --InstanceId "string" \
  --NatGatewayId "string" \
  --NetworkInterfaceId "string" \
  --RouteTableId "string" \
  --VpcPeeringConnectionId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ReplaceRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'GatewayId=string' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'NatGatewayId=string' \
  --data-urlencode 'NetworkInterfaceId=string' \
  --data-urlencode 'RouteTableId=string' \
  --data-urlencode 'VpcPeeringConnectionId=string'

Body (ReplaceRouteRequest):

Body Parameter	Type	Description
DestinationCidrBlock (required)	string	The CIDR block used for the destination match.
GatewayId	string	The ID of an internet gateway or virtual private gateway attached to your VPC.
InstanceId	string	The ID of a NAT instance in your VPC.
NatGatewayId	string	The ID of a NAT gateway.
NetworkInterfaceId	string	The ID of a network interface.
RouteTableId (required)	string	The ID of the route table.
VpcPeeringConnectionId	string	The ID of a VPC peering connection.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (ReplaceRouteResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

ReplaceRouteTableAssociation

POST /ReplaceRouteTableAssociation

Replaces the route table associated with a specific subnet in a VPC with another one.
After the route table is replaced, the subnet uses the routes in the new route table it is associated with.

This AWS-compliant method corresponds to UpdateRouteTableLink in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ReplaceRouteTableAssociation --profile "default" \
  --AssociationId "string" \
  --RouteTableId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ReplaceRouteTableAssociation' \
  --data-urlencode 'AssociationId=string' \
  --data-urlencode 'RouteTableId=string'

Body (ReplaceRouteTableAssociationRequest):

Body Parameter	Type	Description
AssociationId (required)	string	The ID of the current route table association.
RouteTableId (required)	string	The ID of the new route table to associate with the subnet.

Response Elements

{
  "newAssociationId": "string",
  "requestId": "string"
}

Response 200 (ReplaceRouteTableAssociationResponse):

Response Element	Type	Description
newAssociationId	string	The ID of the new route table association.
requestId	string	The ID of the request.

Security Groups

AuthorizeSecurityGroupEgress

POST /AuthorizeSecurityGroupEgress

Adds one or more egress rules to a security group for use with a Virtual Private Cloud (VPC).
It allows instances to send traffic to either one or more destination CIDR IP ranges or destination security groups for the same VPC.
We recommend using a set of IP permissions to authorize outbound access to a destination security group. We also recommend specifying the protocol in a set of IP permissions.

[NOTE]
By default, traffic between two security groups is allowed through both public and private IPs. To restrict it to private IPs only, contact our Support team: support@outscale.com.

This AWS-compliant method corresponds to CreateSecurityGroupRule in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AuthorizeSecurityGroupEgress --profile "default" \
  --CidrIp "string" \
  --FromPort 0 \
  --GroupId "string" \
  --IpPermissions '[
      {
        "FromPort": 0,
        "Groups": [{"GroupId": "string", "GroupName": "string", "UserId": "string"}],
        "IpProtocol": "string",
        "IpRanges": [{"CidrIp": "string"}],
        "PrefixListIds": [{"PrefixListId": "string"}],
        "ToPort": 0
      }
    ]' \
  --IpProtocol "string" \
  --SourceSecurityGroupName "string" \
  --SourceSecurityGroupOwnerId "string" \
  --ToPort 0

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AuthorizeSecurityGroupEgress' \
  --data-urlencode 'CidrIp=string' \
  --data-urlencode 'FromPort=0' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'IpPermissions.0.FromPort=0' \
  --data-urlencode 'IpPermissions.0.Groups.0.GroupId=string' \
  --data-urlencode 'IpPermissions.0.Groups.0.GroupName=string' \
  --data-urlencode 'IpPermissions.0.Groups.0.UserId=string' \
  --data-urlencode 'IpPermissions.0.IpProtocol=string' \
  --data-urlencode 'IpPermissions.0.IpRanges.0.CidrIp=string' \
  --data-urlencode 'IpPermissions.0.PrefixListIds.0.PrefixListId=string' \
  --data-urlencode 'IpPermissions.0.ToPort=0' \
  --data-urlencode 'IpProtocol=string' \
  --data-urlencode 'SourceSecurityGroupName=string' \
  --data-urlencode 'SourceSecurityGroupOwnerId=string' \
  --data-urlencode 'ToPort=0'

Body (AuthorizeSecurityGroupEgressRequest):

Body Parameter	Type	Description
CidrIp	string	The CIDR IP range.
FromPort	integer	The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
GroupId (required)	string	The ID of the security group.
IpPermissions	[IpPermissions_0]	One or more IP permissions.
FromPort	integer	The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
Groups	[Groups_0]	One or more security groups and account ID pairs.
GroupId	string	The ID of the security group (in case of a security group in a nondefault VPC).
GroupName	string	The name of the security group (in case of a security group in FCU or a default VPC).
UserId	string	The ID of the account.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
IpRanges	[IpRanges_0]	One or more IP ranges.
CidrIp	string	The range of IPs.
PrefixListIds	[PrefixListIds_0]	One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
PrefixListId	string	The ID of the prefix.
ToPort	integer	The end of the port range for TCP and UDP protocols, or an ICMP code number.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName	string	The name of a destination security group.
SourceSecurityGroupOwnerId	string	The account ID of the owner of a destination security group.
ToPort	integer	The end of port range for the TCP and UDP protocols, or an ICMP code number.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (AuthorizeSecurityGroupEgressResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

AuthorizeSecurityGroupIngress

POST /AuthorizeSecurityGroupIngress

Adds one or more ingress rules to a security group.
The modifications are effective at instance level as quickly as possible, but a small delay may occur.
In the public Cloud, this action allows one or more CIDR IP ranges to access a security group for your account, or allows one or more security groups (source groups) to access a security group for your own OUTSCALE account or another one.
In a Virtual Private Cloud (VPC), this action allows one or more CIDR IP ranges to access a security group for your VPC, or allows one or more other security groups (source groups) to access a security group for your VPC. All the security groups must be for the same VPC.
To create a rule with a specific IP protocol and a specific port range, we recommend using a set of IP permissions. We also recommend specifying the protocol in a set of IP permissions.

Request Parameters

OSC CLI Shell

osc-cli fcu AuthorizeSecurityGroupIngress --profile "default" \
  --CidrIp "string" \
  --FromPort 0 \
  --GroupId "string" \
  --GroupName "string" \
  --IpPermissions '[
      {
        "FromPort": 0,
        "Groups": [{"GroupId": "string", "GroupName": "string", "UserId": "string"}],
        "IpProtocol": "string",
        "IpRanges": [{"CidrIp": "string"}],
        "PrefixListIds": [{"PrefixListId": "string"}],
        "ToPort": 0
      }
    ]' \
  --IpProtocol "string" \
  --SourceSecurityGroupName "string" \
  --SourceSecurityGroupOwnerId "string" \
  --ToPort 0

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AuthorizeSecurityGroupIngress' \
  --data-urlencode 'CidrIp=string' \
  --data-urlencode 'FromPort=0' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'IpPermissions.0.FromPort=0' \
  --data-urlencode 'IpPermissions.0.Groups.0.GroupId=string' \
  --data-urlencode 'IpPermissions.0.Groups.0.GroupName=string' \
  --data-urlencode 'IpPermissions.0.Groups.0.UserId=string' \
  --data-urlencode 'IpPermissions.0.IpProtocol=string' \
  --data-urlencode 'IpPermissions.0.IpRanges.0.CidrIp=string' \
  --data-urlencode 'IpPermissions.0.PrefixListIds.0.PrefixListId=string' \
  --data-urlencode 'IpPermissions.0.ToPort=0' \
  --data-urlencode 'IpProtocol=string' \
  --data-urlencode 'SourceSecurityGroupName=string' \
  --data-urlencode 'SourceSecurityGroupOwnerId=string' \
  --data-urlencode 'ToPort=0'

Body (AuthorizeSecurityGroupIngressRequest):

Body Parameter	Type	Description
CidrIp	string	The CIDR IP range.
FromPort	integer	The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
GroupId	string	The ID of the security group.
GroupName	string	The name of the security group, if you are in the public Cloud.
IpPermissions	[IpPermissions_0]	Describes a security group rule.
FromPort	integer	The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
Groups	[Groups_0]	One or more security groups and account ID pairs.
GroupId	string	The ID of the security group (in case of a security group in a nondefault VPC).
GroupName	string	The name of the security group (in case of a security group in FCU or a default VPC).
UserId	string	The ID of the account.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
IpRanges	[IpRanges_0]	One or more IP ranges.
CidrIp	string	The range of IPs.
PrefixListIds	[PrefixListIds_0]	One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
PrefixListId	string	The ID of the prefix.
ToPort	integer	The end of the port range for TCP and UDP protocols, or an ICMP code number.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName	string	The name of the source security group (cannot be combined with the `FromPort`, `ToPort`, `CidrIp` and `IpProtocol` parameters).
SourceSecurityGroupOwnerId	string	The OUTSCALE account ID of the owner of the source security group, creating rules that grant full ICMP, UDP, and TCP access (cannot be combined with the `FromPort`, `ToPort`, `CidrIp` and `IpProtocol` parameters).
ToPort	integer	The end of port range for the TCP and UDP protocols, or an ICMP code number.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (AuthorizeSecurityGroupIngressResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

CreateSecurityGroup

POST /CreateSecurityGroup

Creates a security group.
This action creates a security group either in the public Cloud or in a specified Virtual Private Cloud (VPC). By default, a default security group for use in the public Cloud and a default security group for use in a VPC are created.
When launching an instance, if no security group is explicitly specified, the appropriate default security group is assigned to the instance. Default security groups include a default rule granting instances network access to each other.
When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a VPC cannot have the same name.
You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per VPC.
To add or remove rules, use the AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress or RevokeSecurityGroupEgress methods.

For more information, see About Security Groups.
This AWS-compliant method corresponds to CreateSecurityGroup in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateSecurityGroup --profile "default" \
  --DryRun False \
  --GroupDescription "string" \
  --GroupName "string" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateSecurityGroup' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'GroupDescription=string' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'VpcId=string'

Body (CreateSecurityGroupRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
GroupDescription (required)	string	A description for the security group. This description can contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, spaces, and `_.-:/()#,@[]+=&;{}!$*`.
GroupName (required)	string	The name of the security group. This name must not start with `sg-`. This name must be unique and contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, spaces, and `_.-:/()#,@[]+=&;{}!$*`.
VpcId	string	The ID of the VPC.

Response Elements

{
  "groupId": "string",
  "requestId": "string",
  "return": true
}

Response 200 (CreateSecurityGroupResponse):

Response Element	Type	Description
groupId	string	The ID of the security group.
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DeleteSecurityGroup

POST /DeleteSecurityGroup

Deletes a specified security group.
You can specify either the name of the security group or its ID.
This action fails if the specified group is associated with an instance or referenced by another security group.

This AWS-compliant method corresponds to DeleteSecurityGroup in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteSecurityGroup --profile "default" \
  --GroupId "string" \
  --GroupName "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteSecurityGroup' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'GroupName=string'

Body (DeleteSecurityGroupRequest):

Body Parameter	Type	Description
GroupId	string	The ID of the security group. In a Virtual Private Cloud (VPC), this parameter is required.
GroupName	string	(Public Cloud only) The name of the security group.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteSecurityGroupResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeSecurityGroups

POST /DescribeSecurityGroups

Describes one or more security groups.
You can specify either the name of the security groups or their IDs.
You can use the Filter.N parameter to filter the security groups on the following properties:

description: The description of the security group.
group-id: The ID of the security group.
group-name: The name of the security group.
ip-permission.cidr: A CIDR range that has been granted permission.
ip-permission.from-port: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id: The ID of a security group that has been granted permission.
ip-permission.group-name: The name of a security group that has been granted permission.
ip-permission.protocol: The IP protocol for the permission (tcp | udp | icmp, or a protocol number, or -1 for all protocols).
ip-permission.to-port: The end of the port range for the TCP and UDP protocols, or an ICMP code number.
ip-permission.user-id: The account ID that has been granted permission.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.
vpc-id: The ID of the VPC specified when the security group was created.

This AWS-compliant method corresponds to ReadSecurityGroups in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeSecurityGroups --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --GroupId '["string"]' \
  --GroupName '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSecurityGroups' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'GroupId.0=string' \
  --data-urlencode 'GroupName.0=string'

Body (DescribeSecurityGroupsRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeSecurityGroups \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
GroupId	[string]	The ID of one or more security groups.
GroupName	[string]	The name of one or more security groups. This parameter only matches security groups in the public Cloud. To match security groups in a VPC, use the `group-name` filter instead.

Response Elements

{
  "requestId": "string",
  "securityGroupInfo": [
    {
      "groupDescription": "string",
      "groupId": "string",
      "groupName": "string",
      "ipPermissions": [
        {
          "fromPort": 0,
          "groups": [
            {
              "groupId": "string",
              "groupName": "string",
              "userId": "string"
            }
          ],
          "ipProtocol": "string",
          "ipRanges": [
            {
              "cidrIp": "string"
            }
          ],
          "prefixListIds": [
            {
              "prefixListId": "string"
            }
          ],
          "toPort": 0
        }
      ],
      "ipPermissionsEgress": [
        {
          "fromPort": 0,
          "groups": [
            {
              "groupId": "string",
              "groupName": "string",
              "userId": "string"
            }
          ],
          "ipProtocol": "string",
          "ipRanges": [
            {
              "cidrIp": "string"
            }
          ],
          "prefixListIds": [
            {
              "prefixListId": "string"
            }
          ],
          "toPort": 0
        }
      ],
      "ownerId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

Response 200 (DescribeSecurityGroupsResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
securityGroupInfo	[securityGroupInfo]	Information about one or more security groups.
groupDescription	string	A description of the security group.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
ipPermissions	[IpPermissions_1]	The inbound rules associated with the security group.
fromPort	integer	The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
groups	[groups_2]	One or more security groups and account ID pairs.
groupId	string	The ID of the security group (in case of a security group in a nondefault VPC).
groupName	string	The name of the security group (in case of a security group in FCU or a default VPC).
userId	string	The ID of the account.
ipProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
ipRanges	[ipRanges_1]	One or more IP ranges.
cidrIp	string	The range of IPs.
prefixListIds	[PrefixListIds_1]	One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
prefixListId	string	The ID of the prefix.
toPort	integer	The end of the port range for TCP and UDP protocols, or an ICMP code number.
ipPermissionsEgress	[ipPermissionsEgress]	The outbound rules associated with the security group.
fromPort	integer	The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
groups	[groups_2]	One or more security groups and account ID pairs.
groupId	string	The ID of the security group (in case of a security group in a nondefault VPC).
groupName	string	The name of the security group (in case of a security group in FCU or a default VPC).
userId	string	The ID of the account.
ipProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
ipRanges	[ipRanges_1]	One or more IP ranges.
cidrIp	string	The range of IPs.
prefixListIds	[PrefixListIds_1]	One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
prefixListId	string	The ID of the prefix.
toPort	integer	The end of the port range for TCP and UDP protocols, or an ICMP code number.
ownerId	string	The account ID of the owner of the security group.
tagSet	[tagSet_0]	One or more tags associated with the security group.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the VPC for the security group.

RevokeSecurityGroupEgress

POST /RevokeSecurityGroupEgress

Removes one or more egress rules from a security group for a VPC.
In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to indicate ICMP type and code numbers.
Rules (IP permissions) consist of the protocol, CIDR range or source security group.
To revoke outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions.

This AWS-compliant method corresponds to DeleteSecurityGroupRule in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu RevokeSecurityGroupEgress --profile "default" \
  --CidrIp "string" \
  --FromPort 0 \
  --GroupId "string" \
  --IpPermissions '[
      {
        "FromPort": 0,
        "Groups": [{"GroupId": "string", "GroupName": "string", "UserId": "string"}],
        "IpProtocol": "string",
        "IpRanges": [{"CidrIp": "string"}],
        "PrefixListIds": [{"PrefixListId": "string"}],
        "ToPort": 0
      }
    ]' \
  --IpProtocol "string" \
  --SourceSecurityGroupName "string" \
  --SourceSecurityGroupOwnerId "string" \
  --ToPort 0

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RevokeSecurityGroupEgress' \
  --data-urlencode 'CidrIp=string' \
  --data-urlencode 'FromPort=0' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'IpPermissions.0.FromPort=0' \
  --data-urlencode 'IpPermissions.0.Groups.0.GroupId=string' \
  --data-urlencode 'IpPermissions.0.Groups.0.GroupName=string' \
  --data-urlencode 'IpPermissions.0.Groups.0.UserId=string' \
  --data-urlencode 'IpPermissions.0.IpProtocol=string' \
  --data-urlencode 'IpPermissions.0.IpRanges.0.CidrIp=string' \
  --data-urlencode 'IpPermissions.0.PrefixListIds.0.PrefixListId=string' \
  --data-urlencode 'IpPermissions.0.ToPort=0' \
  --data-urlencode 'IpProtocol=string' \
  --data-urlencode 'SourceSecurityGroupName=string' \
  --data-urlencode 'SourceSecurityGroupOwnerId=string' \
  --data-urlencode 'ToPort=0'

Body (RevokeSecurityGroupEgressRequest):

Body Parameter	Type	Description
CidrIp	string	The CIDR IP range.
FromPort	integer	The beginning of port range for the TCP and UDP protocols, or an ICMP type number.
GroupId (required)	string	The ID of the security group.
IpPermissions	[IpPermissions_0]	Information about one or more IP permissions.
FromPort	integer	The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
Groups	[Groups_0]	One or more security groups and account ID pairs.
GroupId	string	The ID of the security group (in case of a security group in a nondefault VPC).
GroupName	string	The name of the security group (in case of a security group in FCU or a default VPC).
UserId	string	The ID of the account.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
IpRanges	[IpRanges_0]	One or more IP ranges.
CidrIp	string	The range of IPs.
PrefixListIds	[PrefixListIds_0]	One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
PrefixListId	string	The ID of the prefix.
ToPort	integer	The end of the port range for TCP and UDP protocols, or an ICMP code number.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName	string	The name of a destination security group.
SourceSecurityGroupOwnerId	string	The OUTSCALE account ID of the owner of a destination security group.
ToPort	integer	The end of port range for the TCP and UDP protocols, or an ICMP code number.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (RevokeSecurityGroupEgressResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

RevokeSecurityGroupIngress

POST /RevokeSecurityGroupIngress

Removes one or more ingress rules from a security group. The values specified in the revoke request must exactly match the value of the existing rule for the rule to be removed.
In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code numbers.
Rules (IP permissions) consist of the protocol, the CIDR range and the source security group.

This AWS-compliant method corresponds to DeleteSecurityGroupRule in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu RevokeSecurityGroupIngress --profile "default" \
  --CidrIp "string" \
  --FromPort 0 \
  --GroupId "string" \
  --GroupName "string" \
  --IpPermissions '[
      {
        "FromPort": 0,
        "Groups": [{"GroupId": "string", "GroupName": "string", "UserId": "string"}],
        "IpProtocol": "string",
        "IpRanges": [{"CidrIp": "string"}],
        "PrefixListIds": [{"PrefixListId": "string"}],
        "ToPort": 0
      }
    ]' \
  --IpProtocol "string" \
  --SourceSecurityGroupName "string" \
  --SourceSecurityGroupOwnerId "string" \
  --ToPort 0

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=RevokeSecurityGroupIngress' \
  --data-urlencode 'CidrIp=string' \
  --data-urlencode 'FromPort=0' \
  --data-urlencode 'GroupId=string' \
  --data-urlencode 'GroupName=string' \
  --data-urlencode 'IpPermissions.0.FromPort=0' \
  --data-urlencode 'IpPermissions.0.Groups.0.GroupId=string' \
  --data-urlencode 'IpPermissions.0.Groups.0.GroupName=string' \
  --data-urlencode 'IpPermissions.0.Groups.0.UserId=string' \
  --data-urlencode 'IpPermissions.0.IpProtocol=string' \
  --data-urlencode 'IpPermissions.0.IpRanges.0.CidrIp=string' \
  --data-urlencode 'IpPermissions.0.PrefixListIds.0.PrefixListId=string' \
  --data-urlencode 'IpPermissions.0.ToPort=0' \
  --data-urlencode 'IpProtocol=string' \
  --data-urlencode 'SourceSecurityGroupName=string' \
  --data-urlencode 'SourceSecurityGroupOwnerId=string' \
  --data-urlencode 'ToPort=0'

Body (RevokeSecurityGroupIngressRequest):

Body Parameter	Type	Description
CidrIp	string	The CIDR IP range.
FromPort	integer	The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
GroupId	string	The ID of the security group.
GroupName	string	The name of the security group, if you are in the public Cloud.
IpPermissions	[IpPermissions_0]	A set of IP permissions.
FromPort	integer	The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
Groups	[Groups_0]	One or more security groups and account ID pairs.
GroupId	string	The ID of the security group (in case of a security group in a nondefault VPC).
GroupName	string	The name of the security group (in case of a security group in FCU or a default VPC).
UserId	string	The ID of the account.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
IpRanges	[IpRanges_0]	One or more IP ranges.
CidrIp	string	The range of IPs.
PrefixListIds	[PrefixListIds_0]	One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
PrefixListId	string	The ID of the prefix.
ToPort	integer	The end of the port range for TCP and UDP protocols, or an ICMP code number.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName	string	The name of the source security group (cannot be specified alongside the CIDR IP range, the start of the port range, the IP protocol, and the end of the port range).
SourceSecurityGroupOwnerId	string	The account ID of the owner of the source security group.
ToPort	integer	The end of the port range for the TCP and UDP protocols, or an ICMP code number.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (RevokeSecurityGroupIngressResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

Snapshots

CopySnapshot

POST /CopySnapshot

Copies 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 ModifySnapshotAttribute method.

This AWS-compliant method corresponds to CreateSnapshot in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CopySnapshot --profile "default" \
  --Description "string" \
  --DestinationRegion "string" \
  --DryRun False \
  --SourceRegion "string" \
  --SourceSnapshotId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CopySnapshot' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DestinationRegion=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'SourceRegion=string' \
  --data-urlencode 'SourceSnapshotId=string'

Body (CopySnapshotRequest):

Body Parameter	Type	Description
Description	string	A description for the new snapshot (if different from the source snapshot one).
DestinationRegion	string	The name of the destination Region, which must be the same as the source Region.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
SourceRegion (required)	string	The name of the source Region, which must be the same as the Region of your account.
SourceSnapshotId (required)	string	The ID of the snapshot you want to copy.

Response Elements

{
  "requestId": "string",
  "snapshotId": "string"
}

Response 200 (CopySnapshotResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
snapshotId	string	The ID of the new snapshot.

CreateSnapshot

POST /CreateSnapshot

Creates a snapshot from one of your volumes.

[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.
This AWS-compliant method corresponds to CreateSnapshot in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateSnapshot --profile "default" \
  --Description "string" \
  --DryRun False \
  --VolumeId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateSnapshot' \
  --data-urlencode 'Description=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VolumeId=string'

Body (CreateSnapshotRequest):

Body Parameter	Type	Description
Description	string	A description for the new snapshot.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VolumeId (required)	string	The ID of the BSU volume you want to create a snapshot of.

Response Elements

{
  "description": "string",
  "encrypted": true,
  "ownerId": "string",
  "progress": "string",
  "requestId": "string",
  "snapshotId": "string",
  "startTime": "string",
  "status": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeSize": 0
}

Response 200 (CreateSnapshotResponse):

Response Element	Type	Description
description	string	A description of the snapshot, if provided in the request.
encrypted	boolean	Indicates whether the snapshot is encrypted or not (always false).
ownerId	string	The account ID of the owner of the snapshot.
progress	string	The progress of the snapshot (a percentage).
requestId	string	The ID of the request.
snapshotId	string	The ID of the newly created snapshot.
startTime	string	The time at which the snapshot was initiated.
status	string	The state of the snapshot (`in-queue` \| `pending` \| `completed`).
tagSet	[tagSet_0]	One or more tags associated with the snapshot.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
volumeId	string	The ID of the volume used to create the snapshot.
volumeSize	integer	The size of the volume, in gibibytes (GiB).

CreateSnapshotExportTask

POST /CreateSnapshotExportTask

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 ImportSnapshot method. For more information, see ImportSnapshot.
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 CopySnapshot direct method. For more information, see CopySnapshot.
The copy of the source snapshot is independent and belongs to you.

For more information, see About Snapshots.
This AWS-compliant method corresponds to CreateSnapshotExportTask in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateSnapshotExportTask --profile "default" \
  --ExportToOsu '{
      "DiskImageFormat": "string",
      "OsuBucket": "string",
      "OsuPrefix": "string",
      "aksk": {
        "AccessKey": "string",
        "SecretKey": "string"
      }
    }' \
  --SnapshotId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateSnapshotExportTask' \
  --data-urlencode 'ExportToOsu.DiskImageFormat=string' \
  --data-urlencode 'ExportToOsu.OsuBucket=string' \
  --data-urlencode 'ExportToOsu.OsuPrefix=string' \
  --data-urlencode 'ExportToOsu.aksk.AccessKey=string' \
  --data-urlencode 'ExportToOsu.aksk.SecretKey=string' \
  --data-urlencode 'SnapshotId=string'

Body (CreateSnapshotExportTaskRequest):

Body Parameter	Type	Description
ExportToOsu (required)	ExportToOsu_1	Information about the snapshot export task.
DiskImageFormat (required)	string	The format of the export disk (`qcow2` \| `raw`).
OsuBucket (required)	string	The name of the OOS bucket where you want to export the snapshot.
OsuPrefix	string	The prefix for the key of the OOS object corresponding to the snapshot.
aksk	aksk	The access key and secret key of the OOS account used to access the bucket.
AccessKey	string	The access key of the OOS account that enables you to access the bucket.
SecretKey	string	The secret key of the OOS account that enables you to access the bucket.
SnapshotId (required)	string	The ID of the snapshot to export.

Response Elements

{
  "requestId": "string",
  "snapshotExportTask": {
    "completion": 0,
    "exportToOsu": {
      "diskImageFormat": "string",
      "osuBucket": "string",
      "osuKey": "string",
      "osuPrefix": "string",
      "aksk": {
        "AccessKey": "string",
        "SecretKey": "string"
      }
    },
    "snapshotExport": {
      "snapshotId": "string"
    },
    "snapshotExportTaskId": "string",
    "state": "string",
    "statusMessage": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

Response 200 (CreateSnapshotExportTaskResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
snapshotExportTask	snapshotExportTask	Information about one or more snapshot export tasks.
completion	integer	The percentage of the task completed.
exportToOsu	exportToOsu_3	Information about the snapshot export task.
diskImageFormat	string	The format of the export disk (`qcow2` \| `raw`).
osuBucket	string	The name of the OOS bucket where the snapshot is exported.
osuKey	string	The key of the OOS object corresponding to the snapshot.
osuPrefix	string	The prefix for the key of the OOS object corresponding to the snapshot.
aksk	aksk	The access key and secret key of the OOS account used to access the bucket.
AccessKey	string	The access key of the OOS account that enables you to access the bucket.
SecretKey	string	The secret key of the OOS account that enables you to access the bucket.
snapshotExport	snapshotExport	Information about the snapshot you want to export.
snapshotId	string	The ID of snapshot to be exported.
snapshotExportTaskId	string	The ID of the snapshot export task.
state	string	The state of the snapshot export task (`pending` \| `active` \| `completed` \| `failed`).
statusMessage	string	If the snapshot export task fails, an error message.
tagSet	[tagSet_0]	One or more tags associated with the snapshot export task.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.

DeleteSnapshot

POST /DeleteSnapshot

Deletes a specified snapshot.
You cannot delete a snapshot that is currently used by an OUTSCALE machine image (OMI). To do so, you first need to delete the corresponding OMI. For more information, see the DeregisterImage method.

This AWS-compliant method corresponds to DeleteSnapshot in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteSnapshot --profile "default" \
  --SnapshotId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteSnapshot' \
  --data-urlencode 'SnapshotId=string'

Body (DeleteSnapshotRequest):

Body Parameter	Type	Description
SnapshotId (required)	string	The ID of the snapshot you want to delete.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteSnapshotResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeSnapshotAttribute

POST /DescribeSnapshotAttribute

Describes the permissions to create a volume from a specified snapshot.

This AWS-compliant method corresponds to ReadSnapshots in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeSnapshotAttribute --profile "default" \
  --Attribute "string" \
  --SnapshotId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSnapshotAttribute' \
  --data-urlencode 'Attribute=string' \
  --data-urlencode 'SnapshotId=string'

Body (DescribeSnapshotAttributeRequest):

Body Parameter	Type	Description
Attribute (required)	string	The snapshot attribute (always `createVolumePermission`).
SnapshotId (required)	string	The ID of the snapshot.

Response Elements

{
  "createVolumePermission": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ],
  "requestId": "string",
  "snapshotId": "string"
}

Response 200 (DescribeSnapshotAttributeResponse):

Response Element	Type	Description
createVolumePermission	[CreateVolumePermission_1]	A list of permissions for creating volumes from the snapshot.
Group	string	The name of the group (`all` if public).
UserId	string	The ID of the account.
requestId	string	The ID of the request.
snapshotId	string	The ID of the snapshot.

DescribeSnapshotExportTasks

POST /DescribeSnapshotExportTasks

Describes one or more snapshot export tasks.

This AWS-compliant method corresponds to ReadSnapshotExportTasks in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeSnapshotExportTasks --profile "default" \
  --SnapshotExportTaskId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSnapshotExportTasks' \
  --data-urlencode 'SnapshotExportTaskId.0=string'

Body (DescribeSnapshotExportTasksRequest):

Body Parameter	Type	Description
SnapshotExportTaskId	[string]	One or more snapshot export tasks IDs.

Response Elements

{
  "requestId": "string",
  "snapshotExportTaskSet": [
    {
      "completion": 0,
      "exportToOsu": {
        "diskImageFormat": "string",
        "osuBucket": "string",
        "osuKey": "string",
        "osuPrefix": "string",
        "aksk": {
          "AccessKey": "string",
          "SecretKey": "string"
        }
      },
      "snapshotExport": {
        "snapshotId": "string"
      },
      "snapshotExportTaskId": "string",
      "state": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Response 200 (DescribeSnapshotExportTasksResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
snapshotExportTaskSet	[snapshotExportTask]	Information about one or more snapshot export tasks.
completion	integer	The percentage of the task completed.
exportToOsu	exportToOsu_3	Information about the snapshot export task.
diskImageFormat	string	The format of the export disk (`qcow2` \| `raw`).
osuBucket	string	The name of the OOS bucket where the snapshot is exported.
osuKey	string	The key of the OOS object corresponding to the snapshot.
osuPrefix	string	The prefix for the key of the OOS object corresponding to the snapshot.
aksk	aksk	The access key and secret key of the OOS account used to access the bucket.
AccessKey	string	The access key of the OOS account that enables you to access the bucket.
SecretKey	string	The secret key of the OOS account that enables you to access the bucket.
snapshotExport	snapshotExport	Information about the snapshot you want to export.
snapshotId	string	The ID of snapshot to be exported.
snapshotExportTaskId	string	The ID of the snapshot export task.
state	string	The state of the snapshot export task (`pending` \| `active` \| `completed` \| `failed`).
statusMessage	string	If the snapshot export task fails, an error message.
tagSet	[tagSet_0]	One or more tags associated with the snapshot export task.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.

DescribeSnapshots

POST /DescribeSnapshots

Describes one or more snapshots that are available to you.
You can filter the described snapshots using the SnapshotId.N, the Owner.N and the RestorableBy.N parameters.
You can also use the Filter.N parameter to filter the snapshots on the following properties:

description: The description of the snapshot.
owner-alias: The account alias of the owner of the snapshot.
owner-id: The account ID of the owner of the snapshot.
progress: The progress of the snapshot, as a percentage.
snapshot-id: The ID of the snapshot.
start-time: The time at which the snapshot was initiated.
status: The state of the snapshot (in-queue | pending | completed | error | deleting).
volume-id: The ID of the volume used to create the snapshot.
volume-size: The size of the volume used to create the snapshot, in gibibytes (GiB).
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

This AWS-compliant method corresponds to ReadSnapshots in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeSnapshots --profile "default" \
  --DryRun False \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --MaxResults 0 \
  --NextToken "string" \
  --Owner '["string"]' \
  --RestorableBy '["string"]' \
  --SnapshotId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSnapshots' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string' \
  --data-urlencode 'Owner.0=string' \
  --data-urlencode 'RestorableBy.0=string' \
  --data-urlencode 'SnapshotId.0=string'

Body (DescribeSnapshotsRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeSnapshots \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use `NextToken` to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NextToken	string	The token to request the next results page.
Owner	[string]	One or more owners of the snapshots.
RestorableBy	[string]	One or more accounts IDs that have the permissions to create volumes from the snapshot.
SnapshotId	[string]	One or more snapshot IDs.

Response Elements

{
  "nextToken": "string",
  "requestId": "string",
  "snapshotSet": [
    {
      "description": "string",
      "encrypted": true,
      "ownerAlias": "string",
      "ownerId": "string",
      "progress": "string",
      "snapshotId": "string",
      "startTime": "string",
      "status": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "volumeId": "string",
      "volumeSize": 0
    }
  ]
}

Response 200 (DescribeSnapshotsResponse):

Response Element	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.
snapshotSet	[snapshotSet]	Information about one or more snapshots.
description	string	The description of the snapshot.
encrypted	boolean	Indicates whether the snapshot is encrypted or not (always false).
ownerAlias	string	The account alias of the owner of the snapshot.
ownerId	string	The account ID of owner of the snapshot.
progress	string	The progress of the snapshot, as a percentage.
snapshotId	string	The unique ID of the snapshot.
startTime	string	The time at which the snapshot was initiated.
status	string	The state of the snapshot (`in-queue` \| `pending` \| `completed` \| `error` \| `deleting`).
statusMessage	string	The error message in case of snapshot copy operation failure.
tagSet	[tagSet_0]	One or more tags associated with the snapshot.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
volumeId	string	The ID of the volume used to create the snapshot.
volumeSize	integer	The size of the volume used to create the snapshot, in gibibytes (GiB).

ImportSnapshot

POST /ImportSnapshot

Imports a snapshot located in an OUTSCALE Object Storage (OOS) bucket.
This method enables you to copy a snapshot from another account that is either within the same Region as the bucket, or in a different one. To copy a snapshot within the same Region, you can also use the CopySnapshot direct method. For more information, see CopySnapshot.
First, the owner of the source snapshot must export it to the bucket by using the CreateSnapshotExportTask method. Then, they must grant you read permission on the bucket via a pre-signed URL. For more information, see Creating a Pre-Signed URL.

This AWS-compliant method corresponds to CreateSnapshot in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ImportSnapshot --profile "default" \
  --description "string" \
  --snapshotLocation "string" \
  --snapshotSize "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ImportSnapshot' \
  --data-urlencode 'description=string' \
  --data-urlencode 'snapshotLocation=string' \
  --data-urlencode 'snapshotSize=string'

Body (ImportSnapshotRequest):

Body Parameter	Type	Description
description	string	The description for the snapshot you want to create in your account.
snapshotLocation (required)	string	The pre-signed URL of the snapshot you want to import. For more information, see Creating a Pre-signed URL.
snapshotSize (required)	string	The size of the snapshot you want to create in your account, in bytes. This size must be greater than or equal to the size of the original, uncompressed snapshot.

Response Elements

{
  "description": "string",
  "encrypted": true,
  "ownerAlias": "string",
  "ownerId": "string",
  "progress": "string",
  "requestId": "string",
  "snapshotId": "string",
  "startTime": "string",
  "status": "string",
  "volumeId": "string",
  "volumeSize": 0
}

Response 200 (ImportSnapshotResponse):

Response Element	Type	Description
description	string	The description of the snapshot created in your account.
encrypted	boolean	Indicates whether the snapshot is encrypted or not (always false).
ownerAlias	string	The alias of the owner of the snapshot created in your account.
ownerId	string	The ID of the owner of the snapshot created in your account.
progress	string	The percentage of the task completed.
requestId	string	The ID of the request.
snapshotId	string	The ID of the snapshot created in your account.
startTime	string	The date and time at which the import task started.
status	string	The state of the snapshot created in your account (`error` \| `completed`).
volumeId	string	The ID of the volume.
volumeSize	integer	The size of the volume, in gibibytes (GiB).

ModifySnapshotAttribute

POST /ModifySnapshotAttribute

Modifies the permissions for a specified snapshot.
You can add or remove permissions for specified account IDs or groups. You can share a snapshot with a user that is in the same Region. The user can create a copy of the snapshot you shared, obtaining all the rights for the copy of the snapshot. For more information, see CopySnapshot.

This AWS-compliant method corresponds to UpdateSnapshot in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ModifySnapshotAttribute --profile "default" \
  --CreateVolumePermission '{
      "Add": [{"Group": "string", "UserId": "string"}],
      "Remove": [{"Group": "string", "UserId": "string"}]
    }' \
  --DryRun False \
  --SnapshotId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifySnapshotAttribute' \
  --data-urlencode 'CreateVolumePermission.Add.0.Group=string' \
  --data-urlencode 'CreateVolumePermission.Add.0.UserId=string' \
  --data-urlencode 'CreateVolumePermission.Remove.0.Group=string' \
  --data-urlencode 'CreateVolumePermission.Remove.0.UserId=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'SnapshotId=string'

Body (ModifySnapshotAttributeRequest):

Body Parameter	Type	Description
CreateVolumePermission	CreateVolumePermission_0	Enables you to modify the permissions to create a volume for account IDs or groups. If you specify both `Add` and `Remove` attributes in the request, only `Add` is taken into account.
Add	[Add]	The account ID you want to add to the list of permissions for the volume.
Group	string	The name of the group (`all` if public).
UserId	string	The ID of the account.
Remove	[Remove]	The account ID you want to remove from the list of permissions for the volume.
Group	string	The name of the group (`all` if public).
UserId	string	The ID of the account.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
SnapshotId (required)	string	The ID of the snapshot.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (ModifySnapshotAttributeResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

Subnets

CreateSubnet

POST /CreateSubnet

Creates a subnet in an existing VPC.
To create a subnet in a VPC, you have to provide the ID of the VPC and the CIDR block for the subnet (its network range). Once the subnet is created, you cannot modify its CIDR block.

For more information, see About Nets.
This AWS-compliant method corresponds to CreateSubnet in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateSubnet --profile "default" \
  --AvailabilityZone "string" \
  --CidrBlock "string" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateSubnet' \
  --data-urlencode 'AvailabilityZone=string' \
  --data-urlencode 'CidrBlock=string' \
  --data-urlencode 'VpcId=string'

Body (CreateSubnetRequest):

Body Parameter	Type	Description
AvailabilityZone	string	The name of the Availability Zone in which you want to create the subnet.
CidrBlock (required)	string	The CIDR block for the subnet (for example, `10.0.0.0/24`). The CIDR block of the subnet can be either the same as the VPC one if you create only a single subnet in this VPC, or a subset of the VPC one. In case of several subnets in a VPC, their CIDR blocks must no overlap. The smallest subnet you can create uses a /29 netmask (eight IPs). For more information, see About Nets.
VpcId (required)	string	The ID of the VPC.

Response Elements

{
  "requestId": "string",
  "subnet": {
    "availabilityZone": "string",
    "availableIpAddressCount": 0,
    "cidrBlock": "string",
    "mapPublicIpOnLaunch": true,
    "state": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

Response 200 (CreateSubnetResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
subnet	subnet	Information about the newly created subnet.
availabilityZone	string	The name of the Availability Zone in which the subnet is located.
availableIpAddressCount	integer	The number of unused IPs in the subnet.
cidrBlock	string	The CIDR block of the subnet (for example, `10.84.7.0/24`).
mapPublicIpOnLaunch	boolean	Specifies whether an External IP (EIP) is assigned to the instances launched in this subnet.
state	string	The state of the subnet (`pending` \| `available` \| `deleted`).
subnetId	string	The ID of the subnet.
tagSet	[tagSet_0]	One or more tags associated with the VPC.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the VPC where the subnet is.

DeleteSubnet

POST /DeleteSubnet

Deletes a specified subnet.
You must terminate all the running instances in the subnet before deleting it.

This AWS-compliant method corresponds to DeleteSubnet in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteSubnet --profile "default" \
  --SubnetId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteSubnet' \
  --data-urlencode 'SubnetId=string'

Body (DeleteSubnetRequest):

Body Parameter	Type	Description
SubnetId (required)	string	The ID of the subnet you want to delete.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteSubnetResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeSubnets

POST /DescribeSubnets

Describes one or more of your subnets.
If you do not specify any subnet ID, this action describes all of your subnets.
You can use the Filter.N parameter to filter the subnets on the following properties:

subnet-id: The ID of the subnet.
vpc-id: The ID of the VPC in which the subnet is.
state: The state of the subnet (pending | available | deleted).
cidr: The exact CIDR block of the subnet (similar to cidr-block).
cidr-block: The exact CIDR block of the subnet (similar to cidr).
available-ip-address-count: The number of available IPs in the subnet.
availability-zone: The Availability Zone in which the subnets are located.

This AWS-compliant method corresponds to ReadSubnets in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeSubnets --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --SubnetId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeSubnets' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'SubnetId.0=string'

Body (DescribeSubnetsRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters.
Name	string	The name of the filter.
Value	[string]	One or more filter values.
SubnetId	[string]	One or more subnet IDs.

Response Elements

{
  "requestId": "string",
  "subnetSet": [
    {
      "availabilityZone": "string",
      "availableIpAddressCount": 0,
      "cidrBlock": "string",
      "mapPublicIpOnLaunch": true,
      "state": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

Response 200 (DescribeSubnetsResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
subnetSet	[subnetSet]	Information about one or more of your subnets.
availabilityZone	string	The name of the Availability Zone in which the subnet is located.
availableIpAddressCount	integer	The number of unused IPs in the subnet.
cidrBlock	string	The CIDR block of the subnet (for example, `10.84.7.0/24`).
mapPublicIpOnLaunch	boolean	Specifies whether an External IP (EIP) is assigned to the instances launched in this subnet.
state	string	The state of the subnet (`pending` \| `available` \| `deleted`).
subnetId	string	The ID of the subnet.
tagSet	[tagSet_0]	One or more tags associated with the VPC.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the VPC where the subnet is.

ModifySubnetAttribute

POST /ModifySubnetAttribute

Modifies the specified attribute of a subnet.

This AWS-compliant method corresponds to UpdateSubnet in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ModifySubnetAttribute --profile "default" \
  --MapPublicIpOnLaunch '{
      "Value": True
    }' \
  --SubnetId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifySubnetAttribute' \
  --data-urlencode 'MapPublicIpOnLaunch.Value=true' \
  --data-urlencode 'SubnetId=string'

Body (ModifySubnetAttributeRequest):

Body Parameter	Type	Description
MapPublicIpOnLaunch	MapPublicIpOnLaunch	If set to true, an External IP (EIP) is automatically assigned to the instance launched with this subnet. The EIP remains assigned to the instance, even when it is stopped, and is released when the instance is terminated.
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.
SubnetId (required)	string	The ID of the subnet.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (ModifySubnetAttributeResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

Tasks

CancelExportTask

POST /CancelExportTask

Cancels an export task.
If the export task is not running, the command fails and an error is returned.

This AWS-compliant method corresponds to DeleteExportTask in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CancelExportTask --profile "default" \
  --ExportTaskId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CancelExportTask' \
  --data-urlencode 'ExportTaskId=string'

Body (CancelExportTaskRequest):

Body Parameter	Type	Description
ExportTaskId (required)	string	The ID of the export task to cancel.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (CancelExportTaskResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

VPC

CreateVpc

POST /CreateVpc

Creates a Virtual Private Cloud (VPC) with a specified CIDR block.
The CIDR block (network range) of your VPC must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).

For more information, see About Nets.
This AWS-compliant method corresponds to CreateNet in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateVpc --profile "default" \
  --CidrBlock "string" \
  --InstanceTenancy "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpc' \
  --data-urlencode 'CidrBlock=string' \
  --data-urlencode 'InstanceTenancy=string'

Body (CreateVpcRequest):

Body Parameter	Type	Description
CidrBlock (required)	string	The CIDR block for the VPC (for example, `10.0.0.0/16`).
InstanceTenancy	string	The tenancy options of the instances (`default` if an instance created in a VPC can be launched with any tenancy, `dedicated` if it can be launched with dedicated tenancy instances running on single-tenant hardware).

Response Elements

{
  "requestId": "string",
  "vpc": {
    "cidrBlock": "string",
    "dhcpOptionsId": "string",
    "instanceTenancy": "string",
    "isDefault": true,
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

Response 200 (CreateVpcResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpc	vpc	Information about the newly created VPC.
cidrBlock	string	The CIDR block of the VPC, in the [16;28] range (for example, `10.84.7.0/24`).
dhcpOptionsId	string	The ID of the DHCP options set associated with the VPC.
instanceTenancy	string	The tenancy of the instances (`default` if an instance created in a VPC can be launched with any tenancy, `dedicated` if it can be launched with dedicated tenancy instances running on single-tenant hardware).
isDefault	boolean	Indicates whether the VPC is the default one (always `false`).
state	string	The state of the VPC (`pending` \| `available` \| `deleted`).
tagSet	[tagSet_0]	One or more tags associated with the VPC.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the Virtual Private Cloud (VPC).

DeleteVpc

POST /DeleteVpc

Deletes a specified VPC.
Before deleting the VPC, you need to delete or detach all the resources associated with the VPC:

Instances
VPC peering connections
Custom route tables
External IPs (EIPs) allocated to resources in the VPC
Flexible network interface created in the subnets
Gateways (Virtual private gateways, internet gateways and NAT gateways)
Load balancers
Security groups
VPC subnets

This AWS-compliant method corresponds to DeleteNet in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteVpc --profile "default" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpc' \
  --data-urlencode 'VpcId=string'

Body (DeleteVpcRequest):

Body Parameter	Type	Description
VpcId (required)	string	The ID of the VPC you want to delete.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteVpcResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeVpcAttribute

POST /DescribeVpcAttribute

Describes a specified attribute of a VPC.

You can specify only one attribute at a time. You can get information about the two following attributes:

EnableDnsSupport: Whether DNS resolution is supported for the VPC.
EnableDnsHostnames: Whether instances launched in the VPC get DNS hostnames.

The description of these attributes always returns true, as the VPCs do not support their deactivation.

This AWS-compliant method corresponds to ReadNets in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeVpcAttribute --profile "default" \
  --Attribute "string" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcAttribute' \
  --data-urlencode 'Attribute=string' \
  --data-urlencode 'VpcId=string'

Body (DescribeVpcAttributeRequest):

Body Parameter	Type	Description
Attribute (required)	string	The attribute name (`enableDnsSupport` or `enableDnsHostnames`).
VpcId (required)	string	The ID of the VPC.

Response Elements

{
  "enableDnsHostnames": {
    "value": true
  },
  "enableDnsSupport": {
    "value": true
  },
  "requestId": "string",
  "vpcId": "string"
}

Response 200 (DescribeVpcAttributeResponse):

Response Element	Type	Description
enableDnsHostnames	EnableDnsHostnames_1	The state of the `enableDnsHostnames` attribute.
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.
enableDnsSupport	EnableDnsSupport_1	The state of the `enableDnsSupport` attribute.
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.
requestId	string	The ID of the request.
vpcId	string	The ID of the VPC.

DescribeVpcs

POST /DescribeVpcs

Describes one or more Virtual Private Clouds (VPCs).
You can use the Filter.N parameter to filter the VPCs on the following properties:

vpc-id: The ID of the VPC.
state: The state of the VPC (pending | available | deleting).
cidr: The exact CIDR block of the VPC.
cidr-block: The exact CIDR block of the VPC (similar to cidr and cidrBlock).
cidrBlock: The exact CIDR block of the VPC (similar to cidr and cidr-block).
dhcp-options-id: The ID of a set of DHCP options.
is-default: Indicates whether the VPC is the default one.
isDefault: Alias to is-default filter.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

This AWS-compliant method corresponds to ReadNets in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeVpcs --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --VpcId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcs' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'VpcId.0=string'

Body (DescribeVpcsRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpcs \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
VpcId	[string]	One or more VPC IDs.

Response Elements

{
  "requestId": "string",
  "vpcSet": [
    {
      "cidrBlock": "string",
      "dhcpOptionsId": "string",
      "isDefault": true,
      "instanceTenancy": "string",
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

Response 200 (DescribeVpcsResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpcSet	[vpcSet]	Information about one or more VPCs.
cidrBlock	string	The CIDR block of the VPC, in the [16;28] range (for example, `10.84.7.0/24`).
dhcpOptionsId	string	The ID of the DHCP options set associated with the VPC.
isDefault	boolean	Indicates whether the VPC is the default one (always `false`).
instanceTenancy	string	The tenancy of the instances (`default` if an instance created in a VPC can be launched with any tenancy, `dedicated` if it can be launched with dedicated tenancy instances running on single-tenant hardware).
state	string	The state of the VPC (`pending` \| `available` \| `deleting`).
tagSet	[tagSet_0]	One or more tags associated with the VPC.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
vpcId	string	The ID of the Virtual Private Cloud (VPC).

VPC Endpoints

CreateVpcEndpoint

POST /CreateVpcEndpoint

Creates a Virtual Private Cloud (VPC) endpoint to access an OUTSCALE service from this VPC without using the internet and External IPs (EIPs).
You specify the service using its prefix list name. For more information, see DescribePrefixLists.

To control the routing of traffic between the VPC and the specified service, you can specify one or more route tables. Instances placed in subnets associated with the specified route table thus use the VPC endpoint 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 endpoint.

When a VPC endpoint is created, an EIP is automatically allocated to your account and used for the VPC endpoint. This EIP 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.
This AWS-compliant method corresponds to CreateNetAccessPoint in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateVpcEndpoint --profile "default" \
  --RouteTableId '["string"]' \
  --ServiceName "string" \
  --VpcId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpcEndpoint' \
  --data-urlencode 'RouteTableId.0=string' \
  --data-urlencode 'ServiceName=string' \
  --data-urlencode 'VpcId=string'

Body (CreateVpcEndpointRequest):

Body Parameter	Type	Description
RouteTableId	[string]	One or more IDs of route tables to use for the connection.
ServiceName (required)	string	The prefix list name corresponding to the service (for example, `com.outscale.eu-west-2.oos` for OOS).
VpcId (required)	string	The ID of the VPC.

Response Elements

{
  "requestId": "string",
  "vpcEndpoint": {
    "creationTimestamp": "string",
    "routeTableIdSet": [
      "string"
    ],
    "serviceName": "string",
    "state": "string",
    "vpcEndpointId": "string",
    "vpcId": "string"
  }
}

Response 200 (CreateVpcEndpointResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpcEndpoint	vpcEndpoint	Information about the newly created VPC endpoint.
creationTimestamp	string	The date and time of creation of the VPC endpoint.
routeTableIdSet	[string]	The ID of the route tables associated with the VPC endpoint.
serviceName	string	The name of the prefix list corresponding to the service with which the VPC endpoint is associated.
state	string	The state of the VPC endpoint (`pending` \| `available` \| `deleting` \| `deleted`).
vpcEndpointId	string	The ID of the VPC endpoint.
vpcId	string	The ID of the VPC with which the VPC endpoint is associated.

DeleteVpcEndpoints

POST /DeleteVpcEndpoints

Deletes one or more Virtual Private Cloud (VPC) endpoint.
This action also deletes the corresponding routes added to the route tables you specified for the VPC endpoint.

This AWS-compliant method corresponds to DeleteNetAccessPoint in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteVpcEndpoints --profile "default" \
  --VpcEndpointId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpcEndpoints' \
  --data-urlencode 'VpcEndpointId.0=string'

Body (DeleteVpcEndpointsRequest):

Body Parameter	Type	Description
VpcEndpointId (required)	[string]	One or more IDs of VPC endpoints you want to delete.

Response Elements

{
  "requestId": "string",
  "unsuccessful": [
    {
      "error": {
        "code": "string",
        "message": "string"
      },
      "resourceId": "string"
    }
  ]
}

Response 200 (DeleteVpcEndpointsResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
unsuccessful	[unsuccessful]	Information about one or more unsuccessfully deleted VPC endpoints.
error	error	Information about the error.
code	string	The error code.
message	string	The error message corresponding to the error code.
resourceId	string	The ID of the resource.

DescribeVpcEndpointServices

POST /DescribeVpcEndpointServices

Describes OUTSCALE services available to create VPC endpoints.
For more information, see CreateVpcEndpoint.

This AWS-compliant method corresponds to ReadNetAccessPointServices in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeVpcEndpointServices --profile "default" \
  --DryRun False \
  --MaxResults 0 \
  --NextToken "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcEndpointServices' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string'

Body (DescribeVpcEndpointServicesRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use the `NextToken` attribute to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NextToken	string	The token to request the next results page.

Response Elements

{
  "nextToken": "string",
  "requestId": "string",
  "serviceNameSet": [
    "string"
  ]
}

Response 200 (DescribeVpcEndpointServicesResponse):

Response Element	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.
serviceNameSet	[string]	The names of the services you can use for VPC endpoints.

DescribeVpcEndpoints

POST /DescribeVpcEndpoints

Describes one or more Virtual Private Cloud (VPC) endpoints.
You can use the Filter.N parameter to filter the VPCs on the following properties:

service-name: The name of the prefix list corresponding to the service. For more information, see DescribePrefixLists.
vpc-id: The ID of the VPC.
vpc-endpoint-id: The ID of the VPC endpoint.
vpc-endpoint-state: The state of the VPC endpoint (pending | available | deleting | deleted).

This AWS-compliant method corresponds to ReadNetAccessPoints in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeVpcEndpoints --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --VpcEndpointId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpcEndpoints' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'VpcEndpointId.0=string'

Body (DescribeVpcEndpointsRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpcEndpoints \` `--Filter.1.Name "vpc-endpoint-id" \` `--Filter.1.Value.1 "vpce-12345678"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
VpcEndpointId	[string]	One or more IDs of VPC endpoints.

Response Elements

{
  "requestId": "string",
  "vpcEndpointSet": [
    {
      "creationTimestamp": "string",
      "routeTableIdSet": [
        "string"
      ],
      "serviceName": "string",
      "state": "string",
      "vpcEndpointId": "string",
      "vpcId": "string"
    }
  ]
}

Response 200 (DescribeVpcEndpointsResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpcEndpointSet	[vpcEndpointSet]	Information about one or more VPC endpoints.
creationTimestamp	string	The date and time of creation of the VPC endpoint.
routeTableIdSet	[string]	The ID of the route tables associated with the VPC endpoint.
serviceName	string	The name of the prefix list corresponding to the service with which the VPC endpoint is associated.
state	string	The state of the VPC endpoint (`pending` \| `available` \| `deleting` \| `deleted`).
vpcEndpointId	string	The ID of the VPC endpoint.
vpcId	string	The ID of the VPC with which the VPC endpoint is associated.

ModifyVpcEndpoint

POST /ModifyVpcEndpoint

Modifies the attributes of a Virtual Private Cloud (VPC) endpoint.
This action enables you to add or remove route tables associated with the specified VPC endpoint.

This AWS-compliant method corresponds to UpdateNetAccessPoint in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu ModifyVpcEndpoint --profile "default" \
  --AddRouteTableId '["string"]' \
  --RemoveRouteTableId '["string"]' \
  --VpcEndpointId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=ModifyVpcEndpoint' \
  --data-urlencode 'AddRouteTableId.0=string' \
  --data-urlencode 'RemoveRouteTableId.0=string' \
  --data-urlencode 'VpcEndpointId=string'

Body (ModifyVpcEndpointRequest):

Body Parameter	Type	Description
AddRouteTableId	[string]	One or more IDs of route tables to associate with the specified VPC endpoint.
RemoveRouteTableId	[string]	One or more IDs of route tables to disassociate from the specified VPC endpoint.
VpcEndpointId (required)	string	The ID of the VPC endpoint.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (ModifyVpcEndpointResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

VPN Connections

CreateVpnConnection

POST /CreateVpnConnection

Creates a VPN connection between a specified virtual private gateway and a specified customer gateway.
You can create only one VPN connection between a virtual private gateway and a customer gateway.

For more information, see About VPN Connections.
This AWS-compliant method corresponds to CreateVpnConnection in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateVpnConnection --profile "default" \
  --CustomerGatewayId "string" \
  --DryRun False \
  --Options '{
      "StaticRoutesOnly": True
    }' \
  --Type "string" \
  --VpnGatewayId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpnConnection' \
  --data-urlencode 'CustomerGatewayId=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Options.StaticRoutesOnly=true' \
  --data-urlencode 'Type=string' \
  --data-urlencode 'VpnGatewayId=string'

Body (CreateVpnConnectionRequest):

Body Parameter	Type	Description
CustomerGatewayId (required)	string	The ID of the customer gateway.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Options	Options_0	Options for a VPN connection.
StaticRoutesOnly	boolean	By default or if false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
Type (required)	string	The type of VPN connection (always `ipsec.1`).
VpnGatewayId (required)	string	The ID of the virtual private gateway.

Response Elements

{
  "requestId": "string",
  "vpnConnection": {
    "customerGatewayConfiguration": "string",
    "customerGatewayId": "string",
    "options": {
      "staticRoutesOnly": true
    },
    "routes": [
      {
        "destinationCidrBlock": "string",
        "source": "string",
        "state": "string"
      }
    ],
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string",
    "vgwTelemetry": [
      {
        "acceptedRouteCount": 0,
        "lastStatusChange": "string",
        "outsideIpAddress": "string",
        "status": "string",
        "statusMessage": "string"
      }
    ],
    "vpnConnectionId": "string",
    "vpnGatewayId": "string"
  }
}

Response 200 (CreateVpnConnectionResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpnConnection	vpnConnection	Information about the VPN connection.
customerGatewayConfiguration	string	Example configuration for the customer gateway, in XML format.
customerGatewayId	string	The ID of the customer gateway used on the customer end of the connection.
options	Options_1	Options for a VPN connection.
staticRoutesOnly	boolean	If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
routes	[routes]	Information about one or more static routes associated with the VPN connection, if any.
destinationCidrBlock	string	The destination range of IPs of the route corresponding to your local network, in CIDR notation.
source	string	The type of route (always `static`).
state	string	The current state of the static route (`pending` \| `available` \| `deleting` \| `deleted`).
state	string	The state of the VPN connection.
tagSet	[tagSet_0]	One or more tags associated with the VPN connection.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
type	string	The type of VPN connection (always `ipsec.1`).
vgwTelemetry	[vgwTelemetry]	Information about the current state of VPN tunnels.
acceptedRouteCount	integer	The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
lastStatusChange	string	The time of the latest state update.
outsideIpAddress	string	The IP on the OUTSCALE side of the tunnel.
status	string	The status of the IPSEC tunnel (`UP` \| `DOWN`).
statusMessage	string	A description of the current state of the tunnel.
vpnConnectionId	string	The ID of the VPN connection.
vpnGatewayId	string	The ID of the virtual private gateway used on the OUTSCALE end of the connection.

CreateVpnConnectionRoute

POST /CreateVpnConnectionRoute

Creates a static route to a VPN connection.
This enables you to select the network flows sent by the virtual private gateway to the target VPN connection.

This AWS-compliant method corresponds to CreateVpnConnectionRoute in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateVpnConnectionRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --DryRun False \
  --VpnConnectionId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpnConnectionRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpnConnectionId=string'

Body (CreateVpnConnectionRouteRequest):

Body Parameter	Type	Description
DestinationCidrBlock (required)	string	The network prefix of the route, in CIDR notation (for example, `10.12.0.0/16`).
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpnConnectionId (required)	string	The ID of target VPN connection of the static route.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (CreateVpnConnectionRouteResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DeleteVpnConnection

POST /DeleteVpnConnection

Deletes a specified VPN connection.
If you want to delete a VPC and all its dependencies, we recommend to detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. This enables you to delete the VPC without waiting for the VPN connection to be deleted.

This AWS-compliant method corresponds to DeleteVpnConnection in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteVpnConnection --profile "default" \
  --DryRun False \
  --VpnConnectionId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpnConnection' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpnConnectionId=string'

Body (DeleteVpnConnectionRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpnConnectionId (required)	string	The ID of the VPN connection you want to delete.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteVpnConnectionResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DeleteVpnConnectionRoute

POST /DeleteVpnConnectionRoute

Deletes a static route to a VPN connection previously created using the CreateVpnConnectionRoute method.

This AWS-compliant method corresponds to DeleteVpnConnectionRoute in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteVpnConnectionRoute --profile "default" \
  --DestinationCidrBlock "string" \
  --DryRun False \
  --VpnConnectionId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpnConnectionRoute' \
  --data-urlencode 'DestinationCidrBlock=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpnConnectionId=string'

Body (DeleteVpnConnectionRouteRequest):

Body Parameter	Type	Description
DestinationCidrBlock (required)	string	The network prefix of the route to delete, in CIDR notation (for example, `10.12.0.0/16`).
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpnConnectionId (required)	string	The ID of the target VPN connection of the static route to delete.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteVpnConnectionRouteResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeVpnConnections

POST /DescribeVpnConnections

Describes one or more VPN connections.
You can use the Filter.N parameter to filter the VPN connections on the following properties:

bgp-asn: The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the connection.
customer-gateway-configuration: The example XML configuration for the customer gateway.
customer-gateway-id: The ID of the customer gateway.
option.static-routes-only: Whether the connection has static routes only.
route.destination-cidr-block: The destination CIDR block.
state: The state of the connection (pending | available | deleting | deleted).
type: The type of connection (always ipsec.1).
vpn-gateway-id: The ID of the virtual private gateway.
vpn-connection-id: The ID of the VPN connection.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

This AWS-compliant method corresponds to ReadVpnConnections in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeVpnConnections --profile "default" \
  --DryRun False \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --VpnConnectionId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpnConnections' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'VpnConnectionId.0=string'

Body (DescribeVpnConnectionsRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpnConnections \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
VpnConnectionId	[string]	One or more VPN connections IDs.

Response Elements

{
  "requestId": "string",
  "vpnConnectionSet": [
    {
      "customerGatewayConfiguration": "string",
      "customerGatewayId": "string",
      "options": {
        "staticRoutesOnly": true
      },
      "routes": [
        {
          "destinationCidrBlock": "string",
          "source": "string",
          "state": "string"
        }
      ],
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string",
      "vgwTelemetry": [
        {
          "acceptedRouteCount": 0,
          "lastStatusChange": "string",
          "outsideIpAddress": "string",
          "status": "string",
          "statusMessage": "string"
        }
      ],
      "vpnConnectionId": "string",
      "vpnGatewayId": "string"
    }
  ]
}

Response 200 (DescribeVpnConnectionsResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpnConnectionSet	[vpnConnectionSet]	Information about one or more VPN connections.
customerGatewayConfiguration	string	Example configuration for the customer gateway, in XML format.
customerGatewayId	string	The ID of the customer gateway used on the customer end of the connection.
options	Options_1	Options for a VPN connection.
staticRoutesOnly	boolean	If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
routes	[routes]	Information about one or more static routes associated with the VPN connection, if any.
destinationCidrBlock	string	The destination range of IPs of the route corresponding to your local network, in CIDR notation.
source	string	The type of route (always `static`).
state	string	The current state of the static route (`pending` \| `available` \| `deleting` \| `deleted`).
state	string	The state of the VPN connection.
tagSet	[tagSet_0]	One or more tags associated with the VPN connection.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
type	string	The type of VPN connection (always `ipsec.1`).
vgwTelemetry	[vgwTelemetry]	Information about the current state of VPN tunnels.
acceptedRouteCount	integer	The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
lastStatusChange	string	The time of the latest state update.
outsideIpAddress	string	The IP on the OUTSCALE side of the tunnel.
status	string	The status of the IPSEC tunnel (`UP` \| `DOWN`).
statusMessage	string	A description of the current state of the tunnel.
vpnConnectionId	string	The ID of the VPN connection.
vpnGatewayId	string	The ID of the virtual private gateway used on the OUTSCALE end of the connection.

Virtual Private Gateways

AttachVpnGateway

POST /AttachVpnGateway

Attaches a virtual private gateway to a VPC.

[IMPORTANT]
This action can be done only if the virtual private gateway is in the available state.

This AWS-compliant method corresponds to LinkVirtualGateway in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AttachVpnGateway --profile "default" \
  --DryRun False \
  --VpcId "string" \
  --VpnGatewayId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AttachVpnGateway' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpcId=string' \
  --data-urlencode 'VpnGatewayId=string'

Body (AttachVpnGatewayRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpcId (required)	string	The ID of the VPC.
VpnGatewayId (required)	string	The ID of the virtual private gateway.

Response Elements

{
  "attachment": {
    "state": "string",
    "vpcId": "string"
  },
  "requestId": "string"
}

Response 200 (AttachVpnGatewayResponse):

Response Element	Type	Description
attachment	attachment_0	Information about the attachment.
state	string	The current state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`).
vpcId	string	The ID of the Virtual Private Cloud (VPC).
requestId	string	The ID of the request.

CreateVpnGateway

POST /CreateVpnGateway

Creates a virtual private gateway.
A virtual private gateway is the endpoint on the VPC side of a VPN connection.

For more information, see About Virtual-Gateways.
This AWS-compliant method corresponds to CreateVirtualGateway in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateVpnGateway --profile "default" \
  --DryRun False \
  --Type "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVpnGateway' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Type=string'

Body (CreateVpnGatewayRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Type (required)	string	The type of VPN connection supported by the virtual private gateway (always `ipsec.1`).

Response Elements

{
  "requestId": "string",
  "vpnGateway": {
    "attachments": [
      {
        "state": "string",
        "vpcId": "string"
      }
    ],
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string",
    "vpnGatewayId": "string"
  }
}

Response 200 (CreateVpnGatewayResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpnGateway	vpnGateway	Information about the newly created virtual private gateway.
attachments	[attachments]	The VPC to which the virtual private gateway is attached.
state	string	The current state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`).
vpcId	string	The ID of the Virtual Private Cloud (VPC).
state	string	The state of the virtual private gateway (`pending` \| `available` \| `deleting` \| `deleted`).
tagSet	[tagSet]	One or more tags associated with the virtual private gateway.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
type	string	The type of VPN connection supported by the virtual private gateway (always `ipsec.1`).
vpnGatewayId	string	The ID of the virtual private gateway.

DeleteVpnGateway

POST /DeleteVpnGateway

Deletes a specified virtual private gateway.
Before deleting a virtual private gateway, we recommend to detach it from the VPC and delete the VPN connection.

This AWS-compliant method corresponds to DeleteVirtualGateway in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteVpnGateway --profile "default" \
  --DryRun False \
  --VpnGatewayId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVpnGateway' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpnGatewayId=string'

Body (DeleteVpnGatewayRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpnGatewayId (required)	string	The ID of the virtual private gateway.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteVpnGatewayResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeVpnGateways

POST /DescribeVpnGateways

Describes one or more virtual private gateways.
You can use the Filter.N parameter to filter the virtual private gateways on the following properties:

attachment.state: The current attachment state between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id: The ID of the VPC the virtual private gateway is attached to.
state: The state of the virtual private gateway (pending | available | deleting | deleted).
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.
type: The type of virtual private gateway (always ipsec.1).
vpn-gateway-id: The ID of the virtual private gateway.

This AWS-compliant method corresponds to ReadVirtualGateways in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeVpnGateways --profile "default" \
  --DryRun False \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --VpnGatewayId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVpnGateways' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'VpnGatewayId.0=string'

Body (DescribeVpnGatewaysRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpnGateways \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
VpnGatewayId	[string]	One or more virtual private gateways.

Response Elements

{
  "requestId": "string",
  "vpnGatewaySet": [
    {
      "attachments": [],
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string",
      "vpnGatewayId": "string"
    }
  ]
}

Response 200 (DescribeVpnGatewaysResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
vpnGatewaySet	[vpnGatewaySet]	Information about one or more virtual private gateways.
attachments	array	The VPC to which the virtual private gateway is attached.
anonymous	any
state	string	The state of the virtual private gateway (`pending` \| `available` \| `deleting` \| `deleted`).
tagSet	[tagSet]	One or more tags associated with the virtual private gateway.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
type	string	The type of VPN connection supported by the virtual private gateway (always `ipsec.1`).
vpnGatewayId	string	The ID of the virtual private gateway.

DetachVpnGateway

POST /DetachVpnGateway

Detaches a virtual private gateway from a VPC.
You must wait until the virtual private gateway is in the detached state before you can attach another VPC to it or delete the VPC it was previously attached to.

This AWS-compliant method corresponds to UnlinkVirtualGateway in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DetachVpnGateway --profile "default" \
  --DryRun False \
  --VpcId "string" \
  --VpnGatewayId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DetachVpnGateway' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VpcId=string' \
  --data-urlencode 'VpnGatewayId=string'

Body (DetachVpnGatewayRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpcId (required)	string	The ID of the VPC.
VpnGatewayId (required)	string	The ID of the virtual private gateway.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DetachVpnGatewayResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DisableVgwRoutePropagation

POST /DisableVgwRoutePropagation

Disables a virtual private gateway from propagating routes to a specified route table of a VPC.

This AWS-compliant method corresponds to UpdateRoutePropagation in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DisableVgwRoutePropagation --profile "default" \
  --GatewayId "string" \
  --RouteTableId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DisableVgwRoutePropagation' \
  --data-urlencode 'GatewayId=string' \
  --data-urlencode 'RouteTableId=string'

Body (DisableVgwRoutePropagationRequest):

Body Parameter	Type	Description
GatewayId (required)	string	The ID of the virtual private gateway.
RouteTableId (required)	string	The ID of the route table.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DisableVgwRoutePropagationResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

EnableVgwRoutePropagation

POST /EnableVgwRoutePropagation

Enables a virtual private gateway to propagate routes to a specified route table of a VPC.

This AWS-compliant method corresponds to UpdateRoutePropagation in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu EnableVgwRoutePropagation --profile "default" \
  --GatewayId "string" \
  --RouteTableId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=EnableVgwRoutePropagation' \
  --data-urlencode 'GatewayId=string' \
  --data-urlencode 'RouteTableId=string'

Body (EnableVgwRoutePropagationRequest):

Body Parameter	Type	Description
GatewayId (required)	string	The ID of the virtual private gateway.
RouteTableId (required)	string	The ID of the route table.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (EnableVgwRoutePropagationResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

Volumes

AttachVolume

POST /AttachVolume

Attaches a BSU volume to an instance.
The volume and the instance must be in the same Availability Zone. The instance can be running or stopped. The volume is attached to the specified instance device.

This AWS-compliant method corresponds to LinkVolume in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu AttachVolume --profile "default" \
  --Device "string" \
  --DryRun False \
  --InstanceId "string" \
  --VolumeId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=AttachVolume' \
  --data-urlencode 'Device=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'VolumeId=string'

Body (AttachVolumeRequest):

Body Parameter	Type	Description
Device (required)	string	The instance device name. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
InstanceId (required)	string	The ID of the instance you want to attach the volume to.
VolumeId (required)	string	The ID of the volume you want to attach.

Response Elements

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "requestId": "string",
  "status": "string",
  "volumeId": "string"
}

Response 200 (AttachVolumeResponse):

Response Element	Type	Description
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
device	string	The instance device name.
instanceId	string	The ID of the instance the volume is attached to.
requestId	string	The ID of the request.
status	string	The attachment state of the volume (`attaching` \| `detaching` \| `attached` \| `detached`).
volumeId	string	The ID of the attached volume.

CreateVolume

POST /CreateVolume

Creates a BSU volume in a specified Region.
BSU volumes can be attached to an instance in the same Availability Zone. You can create an empty volume or restore a volume from an existing snapshot.
You can create the following volume types: Enterprise (io1) for provisioned IOPS SSD volumes, Performance (gp2) for general purpose SSD volumes, or Magnetic (standard) volumes.

For more information, see About Volumes.
This AWS-compliant method corresponds to CreateVolume in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu CreateVolume --profile "default" \
  --AvailabilityZone "string" \
  --DryRun False \
  --Iops 0 \
  --Size 0 \
  --SnapshotId "string" \
  --VolumeType "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=CreateVolume' \
  --data-urlencode 'AvailabilityZone=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Iops=0' \
  --data-urlencode 'Size=0' \
  --data-urlencode 'SnapshotId=string' \
  --data-urlencode 'VolumeType=string'

Body (CreateVolumeRequest):

Body Parameter	Type	Description
AvailabilityZone (required)	string	The Availability Zone in which you want to create the volume.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Iops	integer	The number of I/O operations per second (only for `io1` volumes). The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
Size	integer	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).
SnapshotId	string	The ID of the snapshot from which you want to create the volume.
VolumeType	string	The type of volume you want to create (`io1` \| `gp2` \| `standard`). If not specified, a `standard` volume is created. For more information about volumes types, see Volume Types and IOPS.

Response Elements

{
  "availabilityZone": "string",
  "createTime": "string",
  "iops": 0,
  "requestId": "string",
  "size": 0,
  "snapshotId": "string",
  "status": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeType": "string"
}

Response 200 (CreateVolumeResponse):

Response Element	Type	Description
availabilityZone	string	The Availability Zone of the volume.
createTime	string	The time at which the volume was created.
iops	integer	The number of I/O operations per second (only for `io1` and `gp2` volumes).
requestId	string	The ID of the request.
size	integer	The size of the volume, in GiB.
snapshotId	string	The ID of the snapshot from which the volume was created.
status	string	The state of the volume (always `creating` when creating a volume).
tagSet	[tagSet_0]	The tags associated with the volume.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
volumeId	string	The ID of the newly created volume.
volumeType	string	The type of the volume.

DeleteVolume

POST /DeleteVolume

Deletes a specified BSU volume.
You can delete available volumes only, that is, volumes that are not attached to an instance.

This AWS-compliant method corresponds to DeleteVolume in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DeleteVolume --profile "default" \
  --DryRun False \
  --VolumeId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DeleteVolume' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'VolumeId=string'

Body (DeleteVolumeRequest):

Body Parameter	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VolumeId (required)	string	The ID of the volume.

Response Elements

{
  "requestId": "string",
  "return": true
}

Response 200 (DeleteVolumeResponse):

Response Element	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

DescribeVolumes

POST /DescribeVolumes

Describes one or more specified Block Storage Unit (BSU) volume.
You can use the Filter.N parameter to filter the described volumes on the following properties:

attachment.attach-time: The time at which the attachment was initiated.
attachment.delete-on-termination: Whether the volume is deleted when terminating the instance.
attachment.device: The device to which the volume is plugged in.
attachment.instance-id: The ID of the instance the volume is attached to.
attachment.status: The attachment state (attaching | attached | detaching | detached).
availability-zone: The Availability Zone in which the volume was created.
create-time: The time at which the volume was created.
tag-key: The key of a tag associated with the resource.
tag-value: The value of a tag associated with the resource.
tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.
volume-id: The ID of the volume.
volume-type: The type of the volume (standard | gp2 | io1).
snapshot-id: The snapshot from which the volume was created.
size: The size of the volume, in gibibytes (GiB).
status: The state of the volume (creating | available | in-use | deleting | error).

This AWS-compliant method corresponds to ReadVolumes in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DescribeVolumes --profile "default" \
  --Filter '[
      {
        "Name": "string",
        "Value": ["string"]
      }
    ]' \
  --MaxResults 0 \
  --NextToken "string" \
  --VolumeId '["string"]'

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DescribeVolumes' \
  --data-urlencode 'Filter.0.Name=string' \
  --data-urlencode 'Filter.0.Value.0=string' \
  --data-urlencode 'MaxResults=0' \
  --data-urlencode 'NextToken=string' \
  --data-urlencode 'VolumeId.0=string'

Body (DescribeVolumesRequest):

Body Parameter	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVolumes \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
Name	string	The name of the filter.
Value	[string]	One or more filter values.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use the `NextToken` attribute to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NextToken	string	The token to request the next results page.
VolumeId	[string]	One or more volume IDs.

Response Elements

{
  "nextToken": "string",
  "requestId": "string",
  "volumeSet": [
    {
      "attachmentSet": [
        {
          "attachTime": "string",
          "deleteOnTermination": true,
          "device": "string",
          "instanceId": "string",
          "status": "string",
          "volumeId": "string"
        }
      ],
      "availabilityZone": "string",
      "createTime": "string",
      "iops": 0,
      "size": 0,
      "snapshotId": "string",
      "status": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "volumeId": "string",
      "volumeType": "string"
    }
  ]
}

Response 200 (DescribeVolumesResponse):

Response Element	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.
volumeSet	[volumeSet]	Information about one or more volumes.
attachmentSet	[attachmentSet_0]	Information about your volume attachment.
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
device	string	The name of the device.
instanceId	string	The ID of the instance.
status	string	The attachment state of the volume (`attaching` \| `detaching` \| `attached` \| `detached`).
volumeId	string	The ID of the volume.
availabilityZone	string	The Availability Zone where the volume is.
createTime	string	The date and time of creation of the volume.
iops	integer	The number of I/O operations per second: - For io1 volumes, the number of provisioned IOPS - For gp2 volumes, the baseline performance of the volume
size	integer	The size of the volume, in gibibytes (GiB).
snapshotId	string	The ID of the snapshot from which the volume was created.
status	string	The state of the volume (`creating` \| `available` \| `in-use` \| `deleting` \| `error`).
tagSet	[tagSet_0]	One or more tags associated with the volume.
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.
volumeId	string	The ID of the volume.
volumeType	string	The type of the volume (`standard` \| `gp2` \| `io1`).

DetachVolume

POST /DetachVolume

Detaches a BSU volume from an instance.
To detach the root device of an instance, this instance must be stopped.

This AWS-compliant method corresponds to UnlinkVolume in the OUTSCALE API.

Request Parameters

OSC CLI Shell

osc-cli fcu DetachVolume --profile "default" \
  --Device "string" \
  --DryRun False \
  --Force True \
  --InstanceId "string" \
  --VolumeId "string"

# You need Curl version 7.75 or later to use the --aws-sigv4 option

curl -X POST https://fcu.$OSC_REGION.outscale.com \
  --user $OSC_ACCESS_KEY:$OSC_SECRET_KEY \
  --aws-sigv4 'aws:amz' \
  --data-urlencode 'Version=2016-09-15' \
  --data-urlencode 'Action=DetachVolume' \
  --data-urlencode 'Device=string' \
  --data-urlencode 'DryRun=false' \
  --data-urlencode 'Force=true' \
  --data-urlencode 'InstanceId=string' \
  --data-urlencode 'VolumeId=string'

Body (DetachVolumeRequest):

Body Parameter	Type	Description
Device	string	The name of the device.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Force	boolean	Forces the detachment of the volume in case of previous failure (this action may damage your data or file systems).
InstanceId	string	The ID of the instance.
VolumeId (required)	string	The ID of the volume.

Response Elements

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "requestId": "string",
  "status": "string",
  "volumeId": "string"
}

Response 200 (DetachVolumeResponse):

Response Element	Type	Description
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
device	string	The name of the device.
instanceId	string	The ID of the instance.
requestId	string	The ID of the request.
status	string	The attachment state of the volume (`attaching` \| `detaching` \| `attached` \| `detached`).
volumeId	string	The ID of the volume.

Schemas

AcceptVpcPeeringConnectionRequest

Property	Type	Description
VpcPeeringConnectionId	string	The ID of the VPC peering connection you want to accept.

{
  "VpcPeeringConnectionId": "string"
}

AcceptVpcPeeringConnectionResponse

Property	Type	Description
requestId	string	The ID of the request.
vpcPeeringConnection	vpcPeeringConnection	Information about the created VPC peering connection.

{
  "requestId": "string",
  "vpcPeeringConnection": {
    "accepterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "expirationTime": "string",
    "requesterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "status": {
      "code": "string",
      "message": "string"
    },
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcPeeringConnectionId": "string"
  }
}

Add

The account ID you want to add to the list of permissions for the volume.

Property	Type	Description
Group	string	The name of the group (`all` if public).
UserId	string	The ID of the account.

{
  "Group": "string",
  "UserId": "string"
}

AllocateAddressRequest

Property	Type	Description
Domain	string	The type of platform in which you want to use the EIP (`standard` \| `vpc`). The domain is for information only and does not modify the behavior of the EIP.

{
  "Domain": "string"
}

AllocateAddressResponse

Property	Type	Description
allocationId	string	The ID that represents the allocation of the EIP for use with instances in a VPC.
domain	string	The type of platform in which the EIP is allocated (`standard` \| `vpc`). This element is for information only.
publicIp	string	The EIP.
requestId	string	The ID of the request.

{
  "allocationId": "string",
  "domain": "string",
  "publicIp": "string",
  "requestId": "string"
}

AssignPrivateIpAddressesRequest

Property	Type	Description
AllowReassignment	boolean	If set to true, allows a private IP already assigned to another FNI in the same subnet to be reassigned to the specified FNI.
NetworkInterfaceId	string	The ID of the FNI.
PrivateIpAddress	[string]	One or more secondary private IPs to assign to the FNI within the IP range of the subnet.
SecondaryPrivateIpAddressCount	integer	A number of secondary private IPs to assign to the FNI.

{
  "AllowReassignment": true,
  "NetworkInterfaceId": "string",
  "PrivateIpAddress": [
    "string"
  ],
  "SecondaryPrivateIpAddressCount": 0
}

AssignPrivateIpAddressesResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

AssociateAddressRequest

Property	Type	Description
AllocationId	string	The allocation ID of the EIP. In a VPC, this parameter is required.
AllowReassociation	boolean	- If set to true, allows the EIP to be associated with the instance or network interface that you specify even if it is already associated with another instance or network interface. - If set to false, prevents the EIP from being associated with the instance or network interface that you specify if it is already associated with another instance or network interface. (By default, true in the public Cloud, false in a VPC.)
InstanceId	string	The ID of the instance. - In the public Cloud, this parameter is required. - In a VPC, this parameter is required if the instance has only one network interface. Otherwise, you need to specify the `NetworkInterfaceId` parameter instead. You cannot specify both parameters at the same time.
NetworkInterfaceId	string	(VPC only) The ID of the network interface. This parameter is required if the instance has more than one network interface attached. Otherwise, you need to specify the `InstanceId` parameter instead. You cannot specify both parameters at the same time.
PrivateIpAddress	string	(VPC only) The primary or secondary private IP of the specified network interface. By default, the primary private IP.
PublicIp	string	The EIP. In the public Cloud, this parameter is required.

{
  "AllocationId": "string",
  "AllowReassociation": true,
  "InstanceId": "string",
  "NetworkInterfaceId": "string",
  "PrivateIpAddress": "string",
  "PublicIp": "string"
}

AssociateAddressResponse

Property	Type	Description
associationId	string	(VPC only) The ID that represents the association of the EIP with the instance or the network interface.
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "associationId": "string",
  "requestId": "string",
  "return": true
}

AssociateDhcpOptionsRequest

Property	Type	Description
DhcpOptionsId	string	The ID of the DHCP options set, or `default` if you want to associate the default one.
VpcId	string	The ID of the VPC.

{
  "DhcpOptionsId": "string",
  "VpcId": "string"
}

AssociateDhcpOptionsResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

AssociateRouteTableRequest

Property	Type	Description
RouteTableId	string	The ID of the route table.
SubnetId	string	The ID of the subnet.

{
  "RouteTableId": "string",
  "SubnetId": "string"
}

AssociateRouteTableResponse

Property	Type	Description
associationId	string	The ID of the route table association.
requestId	string	The ID of the request.

{
  "associationId": "string",
  "requestId": "string"
}

AttachInternetGatewayRequest

Property	Type	Description
InternetGatewayId	string	The ID of the internet gateway.
VpcId	string	The ID of the VPC.

{
  "InternetGatewayId": "string",
  "VpcId": "string"
}

AttachInternetGatewayResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

AttachNetworkInterfaceRequest

Property	Type	Description
DeviceIndex	integer	The device index for the FNI attachment (between `1` and `7`, both included).
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
InstanceId	string	The ID of the instance to which you want to attach the FNI.
NetworkInterfaceId	string	The ID of the FNI to attach.

{
  "DeviceIndex": 0,
  "DryRun": true,
  "InstanceId": "string",
  "NetworkInterfaceId": "string"
}

AttachNetworkInterfaceResponse

Property	Type	Description
attachmentId	string	The ID of the attachment operation.
requestId	string	The ID of the request.

{
  "attachmentId": "string",
  "requestId": "string"
}

AttachVolumeRequest

Property	Type	Description
Device	string	The instance device name. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
InstanceId	string	The ID of the instance you want to attach the volume to.
VolumeId	string	The ID of the volume you want to attach.

{
  "Device": "string",
  "DryRun": true,
  "InstanceId": "string",
  "VolumeId": "string"
}

AttachVolumeResponse

Property	Type	Description
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
device	string	The instance device name.
instanceId	string	The ID of the instance the volume is attached to.
requestId	string	The ID of the request.
status	string	The attachment state of the volume (`attaching` \| `detaching` \| `attached` \| `detached`).
volumeId	string	The ID of the attached volume.

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "requestId": "string",
  "status": "string",
  "volumeId": "string"
}

AttachVpnGatewayRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpcId	string	The ID of the VPC.
VpnGatewayId	string	The ID of the virtual private gateway.

{
  "DryRun": true,
  "VpcId": "string",
  "VpnGatewayId": "string"
}

AttachVpnGatewayResponse

Property	Type	Description
attachment	attachment_0	Information about the attachment.
requestId	string	The ID of the request.

{
  "attachment": {
    "state": "string",
    "vpcId": "string"
  },
  "requestId": "string"
}

Attachment

A new configuration for the attachment.

Property	Type	Description
AttachmentId	string	The ID of the FNI attachment.
DeleteOnTermination	boolean	By default or if set to false, the FNI is detached from the instance when the instance is terminated. If true, the FNI is deleted.

{
  "AttachmentId": "string",
  "DeleteOnTermination": true
}

attachments

The VPC to which the virtual private gateway is attached.

Property	Type	Description
state	string	The current state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`).
vpcId	string	The ID of the Virtual Private Cloud (VPC).

{
  "state": "string",
  "vpcId": "string"
}

AuthorizeSecurityGroupEgressRequest

Property	Type	Description
CidrIp	string	The CIDR IP range.
FromPort	integer	The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
GroupId	string	The ID of the security group.
IpPermissions	[IpPermissions_0]	One or more IP permissions.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName	string	The name of a destination security group.
SourceSecurityGroupOwnerId	string	The account ID of the owner of a destination security group.
ToPort	integer	The end of port range for the TCP and UDP protocols, or an ICMP code number.

{
  "CidrIp": "string",
  "FromPort": 0,
  "GroupId": "string",
  "IpPermissions": [
    {
      "FromPort": 0,
      "Groups": [
        {
          "GroupId": "string",
          "GroupName": "string",
          "UserId": "string"
        }
      ],
      "IpProtocol": "string",
      "IpRanges": [
        {
          "CidrIp": "string"
        }
      ],
      "PrefixListIds": [
        {
          "PrefixListId": "string"
        }
      ],
      "ToPort": 0
    }
  ],
  "IpProtocol": "string",
  "SourceSecurityGroupName": "string",
  "SourceSecurityGroupOwnerId": "string",
  "ToPort": 0
}

AuthorizeSecurityGroupEgressResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

AuthorizeSecurityGroupIngressRequest

Property	Type	Description
CidrIp	string	The CIDR IP range.
FromPort	integer	The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
GroupId	string	The ID of the security group.
GroupName	string	The name of the security group, if you are in the public Cloud.
IpPermissions	[IpPermissions_0]	Describes a security group rule.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName	string	The name of the source security group (cannot be combined with the `FromPort`, `ToPort`, `CidrIp` and `IpProtocol` parameters).
SourceSecurityGroupOwnerId	string	The OUTSCALE account ID of the owner of the source security group, creating rules that grant full ICMP, UDP, and TCP access (cannot be combined with the `FromPort`, `ToPort`, `CidrIp` and `IpProtocol` parameters).
ToPort	integer	The end of port range for the TCP and UDP protocols, or an ICMP code number.

{
  "CidrIp": "string",
  "FromPort": 0,
  "GroupId": "string",
  "GroupName": "string",
  "IpPermissions": [
    {
      "FromPort": 0,
      "Groups": [
        {
          "GroupId": "string",
          "GroupName": "string",
          "UserId": "string"
        }
      ],
      "IpProtocol": "string",
      "IpRanges": [
        {
          "CidrIp": "string"
        }
      ],
      "PrefixListIds": [
        {
          "PrefixListId": "string"
        }
      ],
      "ToPort": 0
    }
  ],
  "IpProtocol": "string",
  "SourceSecurityGroupName": "string",
  "SourceSecurityGroupOwnerId": "string",
  "ToPort": 0
}

AuthorizeSecurityGroupIngressResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

BlockDeviceMapping_0

The block device mapping of the instance. This parameter modifies the DeleteOnTermination attribute for volumes attached to the instance.

Property	Type	Description
DeviceName	string	The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
Ebs	Ebs_1	One or more parameters used to automatically set up volumes when you launch the instance.
NoDevice	string	Removes the specified device included in the block device mapping.
VirtualName	string	The name of the virtual device.

{
  "DeviceName": "string",
  "Ebs": {
    "DeleteOnTermination": true,
    "VolumeId": "string"
  },
  "NoDevice": "string",
  "VirtualName": "string"
}

BlockDeviceMapping_1

One or more block device mappings of the instance.

Property	Type	Description
DeviceName	string	The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
Ebs	Ebs_0	One or more parameters to map a volume to `DeviceName` at launch. You can specify either `Ebs` or `VirtualName`, but not both.
NoDevice	string	Prevents a device from being mapped to `DeviceName` at launch, if the OMI used contains a mapping for `DeviceName`. To use this parameter, specify any value other than null, for example an empty string. Example with OSC CLI: `--BlockDeviceMapping.1.DeviceName "/dev/xvdb" \` `--BlockDeviceMapping.1.NoDevice ""`
VirtualName	string	The name of an ephemeral storage disk (`ephemeralN`) to map to `DeviceName` at launch. You can specify either `Ebs` or `VirtualName`, but not both.

{
  "DeviceName": "string",
  "Ebs": {
    "DeleteOnTermination": true,
    "Iops": 0,
    "SnapshotId": "string",
    "VolumeSize": 0,
    "VolumeType": "string"
  },
  "NoDevice": "string",
  "VirtualName": "string"
}

BlockDeviceMapping_2

One or more entries of block device mapping.

Property	Type	Description
deviceName	string	The name of the device.
ebs	Ebs_2	One or more parameters used to automatically set up volumes when you launch the instance.
noDevice	string	Prevents a device from being mapped to `DeviceName` at launch, if the OMI used contains a mapping for `DeviceName`. To use this parameter, specify any value other than null, for example an empty string. Example with OSC CLI: `--BlockDeviceMapping.1.DeviceName "/dev/xvdb" \` `--BlockDeviceMapping.1.NoDevice ""`
virtualName	string	The name of an ephemeral storage disk (`ephemeralN`) to map to `DeviceName` at launch. You can specify either `Ebs` or `VirtualName`, but not both.

{
  "deviceName": "string",
  "ebs": {
    "deleteOnTermination": true,
    "iops": 0,
    "snapshotId": "string",
    "volumeSize": 0,
    "volumeType": "string"
  },
  "noDevice": "string",
  "virtualName": "string"
}

BlockDeviceMapping_3

One or more entries of block device mapping.

Property	Type	Description
deviceName	string	The name of the instance device name.
ebs	ebs	One or more parameters used to automatically set up volumes when the instance is launched.

{
  "deviceName": "string",
  "ebs": {
    "attachTime": "string",
    "deleteOnTermination": true,
    "status": "string",
    "volumeId": "string"
  }
}

CancelExportTaskRequest

Property	Type	Description
ExportTaskId	string	The ID of the export task to cancel.

{
  "ExportTaskId": "string"
}

CancelExportTaskResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

CopyImageRequest

Property	Type	Description
Description	string	A description of the new OMI.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Name	string	The name of the new OMI. This name must be unique for your account. If no name is specified, the name of the new OMI follows this pattern: "source OMI name-copyX", where X is the number of the copy.
SourceImageId	string	The ID of the OMI you want to copy.
SourceRegion	string	The name of the source Region, which must be the same as the Region of your account.

{
  "Description": "string",
  "DryRun": true,
  "Name": "string",
  "SourceImageId": "string",
  "SourceRegion": "string"
}

CopyImageResponse

Property	Type	Description
imageId	string	The ID of the new OMI.
requestId	string	The ID of the request.

{
  "imageId": "string",
  "requestId": "string"
}

CopySnapshotRequest

Property	Type	Description
Description	string	A description for the new snapshot (if different from the source snapshot one).
DestinationRegion	string	The name of the destination Region, which must be the same as the source Region.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
SourceRegion	string	The name of the source Region, which must be the same as the Region of your account.
SourceSnapshotId	string	The ID of the snapshot you want to copy.

{
  "Description": "string",
  "DestinationRegion": "string",
  "DryRun": true,
  "SourceRegion": "string",
  "SourceSnapshotId": "string"
}

CopySnapshotResponse

Property	Type	Description
requestId	string	The ID of the request.
snapshotId	string	The ID of the new snapshot.

{
  "requestId": "string",
  "snapshotId": "string"
}

CreateCustomerGatewayRequest

Property	Type	Description
BgpAsn	integer (int64)	The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the internet (by default, `65000`). This number must be between `1` and `4294967295`, except `50624`, `53306`, and `132418`. If you do not have an ASN, you can choose one between `64512` and `65534` (both included), or between `4200000000` and `4294967295` (both included).
IpAddress	string	The public fixed IPv4 address of your customer gateway.
Type	string	The communication protocol used to establish tunnel with your customer gateway (always `ipsec.1`).

{
  "BgpAsn": 0,
  "IpAddress": "string",
  "Type": "string"
}

CreateCustomerGatewayResponse

Property	Type	Description
customerGateway	customerGateway	Information about the newly created customer gateway.
requestId	string	The ID of the request.

{
  "customerGateway": {
    "bgpAsn": 0,
    "customerGatewayId": "string",
    "ipAddress": "string",
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string"
  },
  "requestId": "string"
}

CreateDhcpOptionsRequest

Property	Type	Description
DhcpConfiguration	[DhcpConfiguration]	A DHCP configuration option.

{
  "DhcpConfiguration": [
    {
      "Key": "string",
      "Value": [
        "string"
      ]
    }
  ]
}

CreateDhcpOptionsResponse

Property	Type	Description
dhcpOptions	dhcpOptions	A set of DHCP options.
requestId	string	The ID of the request.

{
  "dhcpOptions": {
    "dhcpConfigurationSet": [
      {
        "key": "string",
        "valueSet": [
          {
            "value": "string"
          }
        ]
      }
    ],
    "dhcpOptionsId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "requestId": "string"
}

CreateImageExportTaskRequest

Property	Type	Description
ExportToOsu	ExportToOsu_0	Information about the OMI export task.
ImageId	string	The ID of the OMI to export.

{
  "ExportToOsu": {
    "DiskImageFormat": "string",
    "OsuAkSk": {
      "AccessKey": "string",
      "SecretKey": "string"
    },
    "OsuBucket": "string",
    "OsuPrefix": "string"
  },
  "ImageId": "string"
}

CreateImageExportTaskResponse

Property	Type	Description
imageExportTask	imageExportTask	Information about one or more image export tasks.
requestId	string	The ID of the request.

{
  "imageExportTask": {
    "exportToOsu": {
      "diskImageFormat": "string",
      "osuAkSk": {
        "AccessKey": "string",
        "SecretKey": "string"
      },
      "osuBucket": "string",
      "osuManifestUrl": "string",
      "osuPrefix": "string"
    },
    "imageExport": {
      "imageId": "string"
    },
    "imageExportTaskId": "string",
    "state": "string",
    "statusMessage": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "requestId": "string"
}

CreateImageRequest

Property	Type	Description
Description	string	A description for the new OMI.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
InstanceId	string	The ID of the instance from which you want to create the OMI.
Name	string	A unique name for the new OMI. Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces ( ), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`).
NoReboot	boolean	If set to false, the instance shuts down before creating the OMI and then reboots. If set to true, the instance does not.

{
  "Description": "string",
  "DryRun": true,
  "InstanceId": "string",
  "Name": "string",
  "NoReboot": true
}

CreateImageResponse

Property	Type	Description
imageId	string	The ID of the new OMI.
requestId	string	The ID of the request.

{
  "imageId": "string",
  "requestId": "string"
}

CreateInternetGatewayRequest

CreateInternetGatewayResponse

Property	Type	Description
internetGateway	internetGateway	Information about the newly created internet gateway.
requestId	string	The ID of the request.

{
  "internetGateway": {
    "internetGatewayId": "string",
    "attachmentSet": [
      {
        "state": "string",
        "vpcId": "string"
      }
    ],
    "tagSet": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "requestId": "string"
}

CreateKeyPairRequest

Property	Type	Description
KeyName	string	A unique name for the keypair, with a maximum length of 255 ASCII printable characters.

{
  "KeyName": "string"
}

CreateKeyPairResponse

Property	Type	Description
keyFingerprint	string	The MD5 public key fingerprint as specified in section 4 of RFC 4716.
keyMaterial	string	The private key. When saving the private key in a .rsa file, replace the `\n` escape sequences with line breaks.
keyName	string	A unique name for the keypair.
requestId	string	The ID of the request.

{
  "keyFingerprint": "string",
  "keyMaterial": "string",
  "keyName": "string",
  "requestId": "string"
}

CreateNatGatewayRequest

Property	Type	Description
AllocationId	string	The allocation ID of the EIP to associate with the NAT gateway. If the EIP is already associated with another resource, you must first disassociate it.
ClientToken	string	A unique identifier to manage the idempotency.
SubnetId	string	The public subnet where you want to create the NAT gateway.

{
  "AllocationId": "string",
  "ClientToken": "string",
  "SubnetId": "string"
}

CreateNatGatewayResponse

Property	Type	Description
clientToken	string	A unique identifier to manage the idempotency.
natGateway	natGateway	Information about the newly created NAT gateway.
requestId	string	The ID of the request.

{
  "clientToken": "string",
  "natGateway": {
    "createTime": "string",
    "deleteTime": "string",
    "natGatewayAddressSet": [
      {
        "allocationId": "string",
        "networkInterfaceId": "string",
        "privateIp": "string",
        "publicIp": "string"
      }
    ],
    "natGatewayId": "string",
    "state": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  },
  "requestId": "string"
}

CreateNetworkInterfaceRequest

Property	Type	Description
Description	string	A description for the FNI. This description can contain any Unicode character, with no length limit.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
PrivateIpAddress	string	The primary private IP for the FNI. - This IP must be within the IP range of the subnet that you specified with the `subnet-id` attribute. - If you do not specify this attribute, a random private IP is selected within the IP range of the subnet.
SecurityGroupId	[string]	One or more IDs of security groups for the FNI.
SubnetId	string	The ID of the subnet in which you want to create the FNI.

{
  "Description": "string",
  "DryRun": true,
  "PrivateIpAddress": "string",
  "SecurityGroupId": [
    "string"
  ],
  "SubnetId": "string"
}

CreateNetworkInterfaceResponse

Property	Type	Description
networkInterface	NetworkInterface_1	Information about the newly created FNI.
requestId	string	The ID of the request.

{
  "networkInterface": {
    "association": {
      "allocationId": "string",
      "associationId": "string",
      "ipOwnerId": "string",
      "publicDnsName": "string",
      "publicIp": "string"
    },
    "attachment": {
      "attachTime": "string",
      "attachmentId": "string",
      "deleteOnTermination": true,
      "deviceIndex": 0,
      "instanceId": "string",
      "instanceOwnerId": "string",
      "status": "string"
    },
    "availabilityZone": "string",
    "description": "string",
    "groupSet": [
      {
        "groupId": "string",
        "groupName": "string"
      }
    ],
    "macAddress": "string",
    "networkInterfaceId": "string",
    "ownerId": "string",
    "privateDnsName": "string",
    "privateIpAddress": "string",
    "privateIpAddressesSet": [
      {
        "association": {
          "allocationId": "string",
          "associationId": "string",
          "ipOwnerId": "string",
          "publicDnsName": "string",
          "publicIp": "string"
        },
        "primary": true,
        "privateDnsName": "string",
        "privateIpAddress": "string"
      }
    ],
    "sourceDestCheck": true,
    "status": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  },
  "requestId": "string"
}

CreateRouteRequest

Property	Type	Description
DestinationCidrBlock	string	The CIDR block used for the destination match.
GatewayId	string	The ID of an internet gateway or virtual private gateway attached to your VPC.
InstanceId	string	The ID of a NAT instance in your VPC (attached to exactly one network interface).
NatGatewayId	string	The ID of a NAT gateway.
NetworkInterfaceId	string	The ID of a network interface.
RouteTableId	string	The ID of the route table.
VpcPeeringConnectionId	string	The ID of a VPC peering connection.

{
  "DestinationCidrBlock": "string",
  "GatewayId": "string",
  "InstanceId": "string",
  "NatGatewayId": "string",
  "NetworkInterfaceId": "string",
  "RouteTableId": "string",
  "VpcPeeringConnectionId": "string"
}

CreateRouteResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

CreateRouteTableRequest

Property	Type	Description
VpcId	string	The ID of the VPC.

{
  "VpcId": "string"
}

CreateRouteTableResponse

Property	Type	Description
requestId	string	The ID of the request.
routeTable	routeTable	Information about the newly created route table.

{
  "requestId": "string",
  "routeTable": {
    "associationSet": [
      {
        "main": true,
        "routeTableAssociationId": "string",
        "routeTableId": "string",
        "subnetId": "string"
      }
    ],
    "propagatingVgwSet": [
      {
        "gatewayId": "string"
      }
    ],
    "routeSet": [
      {
        "destinationCidrBlock": "string",
        "destinationPrefixListId": "string",
        "gatewayId": "string",
        "instanceId": "string",
        "instanceOwnerId": "string",
        "networkInterfaceId": "string",
        "origin": "string",
        "state": "string",
        "vpcPeeringConnectionId": "string"
      }
    ],
    "routeTableId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

CreateSecurityGroupRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
GroupDescription	string	A description for the security group. This description can contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, spaces, and `_.-:/()#,@[]+=&;{}!$*`.
GroupName	string	The name of the security group. This name must not start with `sg-`. This name must be unique and contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, spaces, and `_.-:/()#,@[]+=&;{}!$*`.
VpcId	string	The ID of the VPC.

{
  "DryRun": true,
  "GroupDescription": "string",
  "GroupName": "string",
  "VpcId": "string"
}

CreateSecurityGroupResponse

Property	Type	Description
groupId	string	The ID of the security group.
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "groupId": "string",
  "requestId": "string",
  "return": true
}

CreateSnapshotExportTaskRequest

Property	Type	Description
ExportToOsu	ExportToOsu_1	Information about the snapshot export task.
SnapshotId	string	The ID of the snapshot to export.

{
  "ExportToOsu": {
    "DiskImageFormat": "string",
    "OsuBucket": "string",
    "OsuPrefix": "string",
    "aksk": {
      "AccessKey": "string",
      "SecretKey": "string"
    }
  },
  "SnapshotId": "string"
}

CreateSnapshotExportTaskResponse

Property	Type	Description
requestId	string	The ID of the request.
snapshotExportTask	snapshotExportTask	Information about one or more snapshot export tasks.

{
  "requestId": "string",
  "snapshotExportTask": {
    "completion": 0,
    "exportToOsu": {
      "diskImageFormat": "string",
      "osuBucket": "string",
      "osuKey": "string",
      "osuPrefix": "string",
      "aksk": {
        "AccessKey": "string",
        "SecretKey": "string"
      }
    },
    "snapshotExport": {
      "snapshotId": "string"
    },
    "snapshotExportTaskId": "string",
    "state": "string",
    "statusMessage": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

CreateSnapshotRequest

Property	Type	Description
Description	string	A description for the new snapshot.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VolumeId	string	The ID of the BSU volume you want to create a snapshot of.

{
  "Description": "string",
  "DryRun": true,
  "VolumeId": "string"
}

CreateSnapshotResponse

Property	Type	Description
description	string	A description of the snapshot, if provided in the request.
encrypted	boolean	Indicates whether the snapshot is encrypted or not (always false).
ownerId	string	The account ID of the owner of the snapshot.
progress	string	The progress of the snapshot (a percentage).
requestId	string	The ID of the request.
snapshotId	string	The ID of the newly created snapshot.
startTime	string	The time at which the snapshot was initiated.
status	string	The state of the snapshot (`in-queue` \| `pending` \| `completed`).
tagSet	[tagSet_0]	One or more tags associated with the snapshot.
volumeId	string	The ID of the volume used to create the snapshot.
volumeSize	integer	The size of the volume, in gibibytes (GiB).

{
  "description": "string",
  "encrypted": true,
  "ownerId": "string",
  "progress": "string",
  "requestId": "string",
  "snapshotId": "string",
  "startTime": "string",
  "status": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeSize": 0
}

CreateSubnetRequest

Property	Type	Description
AvailabilityZone	string	The name of the Availability Zone in which you want to create the subnet.
CidrBlock	string	The CIDR block for the subnet (for example, `10.0.0.0/24`). The CIDR block of the subnet can be either the same as the VPC one if you create only a single subnet in this VPC, or a subset of the VPC one. In case of several subnets in a VPC, their CIDR blocks must no overlap. The smallest subnet you can create uses a /29 netmask (eight IPs). For more information, see About Nets.
VpcId	string	The ID of the VPC.

{
  "AvailabilityZone": "string",
  "CidrBlock": "string",
  "VpcId": "string"
}

CreateSubnetResponse

Property	Type	Description
requestId	string	The ID of the request.
subnet	subnet	Information about the newly created subnet.

{
  "requestId": "string",
  "subnet": {
    "availabilityZone": "string",
    "availableIpAddressCount": 0,
    "cidrBlock": "string",
    "mapPublicIpOnLaunch": true,
    "state": "string",
    "subnetId": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

CreateTagsRequest

Property	Type	Description
ResourceId	[string]	One or more resource IDs.
Tag	[Tag]	One or more tags you want to add to the specified resources. Example for an instance: `osc-cli fcu CreateTags \` `--ResourceId i-xxxxxxxx \` `--Tag.1.Key "AAAA" --Tag.1.Value "BBBB"\` `--Tag.2.Key "CCCC" --Tag.2.Value "DDDD"`

{
  "ResourceId": [
    "string"
  ],
  "Tag": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

CreateTagsResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

CreateVolumePermission_0

Enables you to modify the permissions to create a volume for account IDs or groups. If you specify both Add and Remove attributes in the request, only Add is taken into account.

Property	Type	Description
Add	[Add]	The account ID you want to add to the list of permissions for the volume.
Remove	[Remove]	The account ID you want to remove from the list of permissions for the volume.

{
  "Add": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ],
  "Remove": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ]
}

CreateVolumePermission_1

A list of permissions for creating volumes from the snapshot.

Property	Type	Description
Group	string	The name of the group (`all` if public).
UserId	string	The ID of the account.

{
  "Group": "string",
  "UserId": "string"
}

CreateVolumeRequest

Property	Type	Description
AvailabilityZone	string	The Availability Zone in which you want to create the volume.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Iops	integer	The number of I/O operations per second (only for `io1` volumes). The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
Size	integer	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).
SnapshotId	string	The ID of the snapshot from which you want to create the volume.
VolumeType	string	The type of volume you want to create (`io1` \| `gp2` \| `standard`). If not specified, a `standard` volume is created. For more information about volumes types, see Volume Types and IOPS.

{
  "AvailabilityZone": "string",
  "DryRun": true,
  "Iops": 0,
  "Size": 0,
  "SnapshotId": "string",
  "VolumeType": "string"
}

CreateVolumeResponse

Property	Type	Description
availabilityZone	string	The Availability Zone of the volume.
createTime	string	The time at which the volume was created.
iops	integer	The number of I/O operations per second (only for `io1` and `gp2` volumes).
requestId	string	The ID of the request.
size	integer	The size of the volume, in GiB.
snapshotId	string	The ID of the snapshot from which the volume was created.
status	string	The state of the volume (always `creating` when creating a volume).
tagSet	[tagSet_0]	The tags associated with the volume.
volumeId	string	The ID of the newly created volume.
volumeType	string	The type of the volume.

{
  "availabilityZone": "string",
  "createTime": "string",
  "iops": 0,
  "requestId": "string",
  "size": 0,
  "snapshotId": "string",
  "status": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeType": "string"
}

CreateVpcEndpointRequest

Property	Type	Description
RouteTableId	[string]	One or more IDs of route tables to use for the connection.
ServiceName	string	The prefix list name corresponding to the service (for example, `com.outscale.eu-west-2.oos` for OOS).
VpcId	string	The ID of the VPC.

{
  "RouteTableId": [
    "string"
  ],
  "ServiceName": "string",
  "VpcId": "string"
}

CreateVpcEndpointResponse

Property	Type	Description
requestId	string	The ID of the request.
vpcEndpoint	vpcEndpoint	Information about the newly created VPC endpoint.

{
  "requestId": "string",
  "vpcEndpoint": {
    "creationTimestamp": "string",
    "routeTableIdSet": [
      "string"
    ],
    "serviceName": "string",
    "state": "string",
    "vpcEndpointId": "string",
    "vpcId": "string"
  }
}

CreateVpcPeeringConnectionRequest

Property	Type	Description
PeerOwnerId	string	The account ID of the owner of the VPC you want to connect with. By default, it is your account ID.
PeerVpcId	string	The ID of the VPC you want to connect with.
VpcId	string	The ID of the VPC you send the request from.

{
  "PeerOwnerId": "string",
  "PeerVpcId": "string",
  "VpcId": "string"
}

CreateVpcPeeringConnectionResponse

Property	Type	Description
requestId	string	The ID of the request.
vpcPeeringConnection	vpcPeeringConnection	Information about the created VPC peering connection.

{
  "requestId": "string",
  "vpcPeeringConnection": {
    "accepterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "expirationTime": "string",
    "requesterVpcInfo": {
      "cidrBlock": "string",
      "ownerId": "string",
      "vpcId": "string"
    },
    "status": {
      "code": "string",
      "message": "string"
    },
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcPeeringConnectionId": "string"
  }
}

CreateVpcRequest

Property	Type	Description
CidrBlock	string	The CIDR block for the VPC (for example, `10.0.0.0/16`).
InstanceTenancy	string	The tenancy options of the instances (`default` if an instance created in a VPC can be launched with any tenancy, `dedicated` if it can be launched with dedicated tenancy instances running on single-tenant hardware).

{
  "CidrBlock": "string",
  "InstanceTenancy": "string"
}

CreateVpcResponse

Property	Type	Description
requestId	string	The ID of the request.
vpc	vpc	Information about the newly created VPC.

{
  "requestId": "string",
  "vpc": {
    "cidrBlock": "string",
    "dhcpOptionsId": "string",
    "instanceTenancy": "string",
    "isDefault": true,
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "vpcId": "string"
  }
}

CreateVpnConnectionRequest

Property	Type	Description
CustomerGatewayId	string	The ID of the customer gateway.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Options	Options_0	Options for a VPN connection.
Type	string	The type of VPN connection (always `ipsec.1`).
VpnGatewayId	string	The ID of the virtual private gateway.

{
  "CustomerGatewayId": "string",
  "DryRun": true,
  "Options": {
    "StaticRoutesOnly": true
  },
  "Type": "string",
  "VpnGatewayId": "string"
}

CreateVpnConnectionResponse

Property	Type	Description
requestId	string	The ID of the request.
vpnConnection	vpnConnection	Information about the VPN connection.

{
  "requestId": "string",
  "vpnConnection": {
    "customerGatewayConfiguration": "string",
    "customerGatewayId": "string",
    "options": {
      "staticRoutesOnly": true
    },
    "routes": [
      {
        "destinationCidrBlock": "string",
        "source": "string",
        "state": "string"
      }
    ],
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string",
    "vgwTelemetry": [
      {
        "acceptedRouteCount": 0,
        "lastStatusChange": "string",
        "outsideIpAddress": "string",
        "status": "string",
        "statusMessage": "string"
      }
    ],
    "vpnConnectionId": "string",
    "vpnGatewayId": "string"
  }
}

CreateVpnConnectionRouteRequest

Property	Type	Description
DestinationCidrBlock	string	The network prefix of the route, in CIDR notation (for example, `10.12.0.0/16`).
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpnConnectionId	string	The ID of target VPN connection of the static route.

{
  "DestinationCidrBlock": "string",
  "DryRun": true,
  "VpnConnectionId": "string"
}

CreateVpnConnectionRouteResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

CreateVpnGatewayRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Type	string	The type of VPN connection supported by the virtual private gateway (always `ipsec.1`).

{
  "DryRun": true,
  "Type": "string"
}

CreateVpnGatewayResponse

Property	Type	Description
requestId	string	The ID of the request.
vpnGateway	vpnGateway	Information about the newly created virtual private gateway.

{
  "requestId": "string",
  "vpnGateway": {
    "attachments": [
      {
        "state": "string",
        "vpcId": "string"
      }
    ],
    "state": "string",
    "tagSet": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "type": "string",
    "vpnGatewayId": "string"
  }
}

DeleteCustomerGatewayRequest

Property	Type	Description
CustomerGatewayId	string	The ID of the customer gateway you want to delete.

{
  "CustomerGatewayId": "string"
}

DeleteCustomerGatewayResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteDhcpOptionsRequest

Property	Type	Description
DhcpOptionsId	string	The ID of the DHCP options set.

{
  "DhcpOptionsId": "string"
}

DeleteDhcpOptionsResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteInternetGatewayRequest

Property	Type	Description
InternetGatewayId	string	The ID of the internet gateway.

{
  "InternetGatewayId": "string"
}

DeleteInternetGatewayResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteKeyPairRequest

Property	Type	Description
KeyName	string	The name of the keypair.

{
  "KeyName": "string"
}

DeleteKeyPairResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteNatGatewayRequest

Property	Type	Description
NatGatewayId	string	The ID of the NAT gateway.

{
  "NatGatewayId": "string"
}

DeleteNatGatewayResponse

Property	Type	Description
natGatewayId	string	The ID of the deleted NAT gateway.
requestId	string	The ID if the request.

{
  "natGatewayId": "string",
  "requestId": "string"
}

DeleteNetworkInterfaceRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
NetworkInterfaceId	string	The ID of the FNI.

{
  "DryRun": true,
  "NetworkInterfaceId": "string"
}

DeleteNetworkInterfaceResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteRouteRequest

Property	Type	Description
DestinationCidrBlock	string	The exact CIDR range for the route.
RouteTableId	string	The ID of the route table you want to delete.

{
  "DestinationCidrBlock": "string",
  "RouteTableId": "string"
}

DeleteRouteResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteRouteTableRequest

Property	Type	Description
RouteTableId	string	The ID of the route table.

{
  "RouteTableId": "string"
}

DeleteRouteTableResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteSecurityGroupRequest

Property	Type	Description
GroupId	string	The ID of the security group. In a Virtual Private Cloud (VPC), this parameter is required.
GroupName	string	(Public Cloud only) The name of the security group.

{
  "GroupId": "string",
  "GroupName": "string"
}

DeleteSecurityGroupResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteSnapshotRequest

Property	Type	Description
SnapshotId	string	The ID of the snapshot you want to delete.

{
  "SnapshotId": "string"
}

DeleteSnapshotResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteSubnetRequest

Property	Type	Description
SubnetId	string	The ID of the subnet you want to delete.

{
  "SubnetId": "string"
}

DeleteSubnetResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteTagsRequest

Property	Type	Description
ResourceId	[string]	One or more resource IDs.
Tag	[Tag]	One or more tags you want to delete from the specified resources. (if you set a tag value, only the tags matching exactly this value are deleted)

{
  "ResourceId": [
    "string"
  ],
  "Tag": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

DeleteTagsResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteVolumeRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VolumeId	string	The ID of the volume.

{
  "DryRun": true,
  "VolumeId": "string"
}

DeleteVolumeResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteVpcEndpointsRequest

Property	Type	Description
VpcEndpointId	[string]	One or more IDs of VPC endpoints you want to delete.

{
  "VpcEndpointId": [
    "string"
  ]
}

DeleteVpcEndpointsResponse

Property	Type	Description
requestId	string	The ID of the request.
unsuccessful	[unsuccessful]	Information about one or more unsuccessfully deleted VPC endpoints.

{
  "requestId": "string",
  "unsuccessful": [
    {
      "error": {
        "code": "string",
        "message": "string"
      },
      "resourceId": "string"
    }
  ]
}

DeleteVpcPeeringConnectionRequest

Property	Type	Description
VpcPeeringConnectionId	string	The ID of the VPC peering connection you want to delete.

{
  "VpcPeeringConnectionId": "string"
}

DeleteVpcPeeringConnectionResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteVpcRequest

Property	Type	Description
VpcId	string	The ID of the VPC you want to delete.

{
  "VpcId": "string"
}

DeleteVpcResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteVpnConnectionRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpnConnectionId	string	The ID of the VPN connection you want to delete.

{
  "DryRun": true,
  "VpnConnectionId": "string"
}

DeleteVpnConnectionResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteVpnConnectionRouteRequest

Property	Type	Description
DestinationCidrBlock	string	The network prefix of the route to delete, in CIDR notation (for example, `10.12.0.0/16`).
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpnConnectionId	string	The ID of the target VPN connection of the static route to delete.

{
  "DestinationCidrBlock": "string",
  "DryRun": true,
  "VpnConnectionId": "string"
}

DeleteVpnConnectionRouteResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeleteVpnGatewayRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpnGatewayId	string	The ID of the virtual private gateway.

{
  "DryRun": true,
  "VpnGatewayId": "string"
}

DeleteVpnGatewayResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DeregisterImageRequest

Property	Type	Description
ImageId	string	The ID of the OMI you want to deregister.

{
  "ImageId": "string"
}

DeregisterImageResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DescribeAddressesRequest

Property	Type	Description
AllocationId	[string]	One ore more allocation IDs.
Filter	[Filter]	One or more filters.
PublicIp	[string]	One or more EIPs.

{
  "AllocationId": [
    "string"
  ],
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "PublicIp": [
    "string"
  ]
}

DescribeAddressesResponse

Property	Type	Description
addressesSet	[addressesSet]	Information about one or more EIPs.
requestId	string	The ID of the request.

{
  "addressesSet": [
    {
      "allocationId": "string",
      "associationId": "string",
      "domain": "string",
      "instanceId": "string",
      "networkInterfaceId": "string",
      "networkInterfaceOwnerId": "string",
      "privateIpAddress": "string",
      "publicIp": "string"
    }
  ],
  "requestId": "string"
}

DescribeAvailabilityZonesRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeAvailabilityZones \` `--Filter.1.Name "state" \` `--Filter.1.Value.1 "available"`
ZoneName	[string]	Information about one or more Availability Zones.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "ZoneName": [
    "string"
  ]
}

DescribeAvailabilityZonesResponse

Property	Type	Description
availabilityZoneInfo	[availabilityZoneInfo]	Information about the Availability Zones.
requestId	string	The ID of the request.

{
  "availabilityZoneInfo": [
    {
      "regionName": "string",
      "zoneName": "string",
      "zoneState": "string"
    }
  ],
  "requestId": "string"
}

DescribeCustomerGatewaysRequest

Property	Type	Description
CustomerGatewayId	[string]	One or more customer gateways IDs.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeCustomerGateways \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`

{
  "CustomerGatewayId": [
    "string"
  ],
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ]
}

DescribeCustomerGatewaysResponse

Property	Type	Description
customerGatewaySet	[customerGatewaySet]	One or more customer gateways.
requestId	string	The ID of the request.

{
  "customerGatewaySet": [
    {
      "bgpAsn": 0,
      "customerGatewayId": "string",
      "ipAddress": "string",
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string"
    }
  ],
  "requestId": "string"
}

DescribeDhcpOptionsRequest

Property	Type	Description
DhcpOptionsId	[string]	One or more IDs of DHCP options sets. If you do not specify any ID, this action describes all your DHCP options sets.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeDhcpOptions \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`

{
  "DhcpOptionsId": [
    "string"
  ],
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ]
}

DescribeDhcpOptionsResponse

Property	Type	Description
dhcpOptionsSet	[dhcpOptionsSet]	One or more DHCP options sets.
requestId	string	The ID of the request.

{
  "dhcpOptionsSet": [
    {
      "dhcpConfigurationSet": [
        {
          "key": "string",
          "valueSet": [
            {
              "value": "string"
            }
          ]
        }
      ],
      "dhcpOptionsId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

DescribeImageAttributeRequest

Property	Type	Description
Attribute	string	The OMI attribute (`description` \| `launchPermission` \| `productCodes`).
ImageId	string	The ID of the OMI.

{
  "Attribute": "string",
  "ImageId": "string"
}

DescribeImageAttributeResponse

Property	Type	Description
description	Description_1	The description of the resource.
imageId	string	The ID of the OMI.
launchPermission	[launchPermission_1]	One or more launch permissions.
productCodes	[productCodes]	One or more product codes associated with the OMI.
requestId	string	The ID of the request.

{
  "description": {
    "value": "string"
  },
  "imageId": "string",
  "launchPermission": [
    {
      "group": "string",
      "userId": "string"
    }
  ],
  "productCodes": [
    {
      "productCode": "string",
      "type": "string"
    }
  ],
  "requestId": "string"
}

DescribeImageExportTasksRequest

Property	Type	Description
ImageExportTaskId	[string]	One or more image export tasks IDs.

{
  "ImageExportTaskId": [
    "string"
  ]
}

DescribeImageExportTasksResponse

Property	Type	Description
imageExportTaskSet	[imageExportTask]	Information about one or more image export tasks.
requestId	string	The ID of the request.

{
  "imageExportTaskSet": [
    {
      "exportToOsu": {
        "diskImageFormat": "string",
        "osuAkSk": {
          "AccessKey": "string",
          "SecretKey": "string"
        },
        "osuBucket": "string",
        "osuManifestUrl": "string",
        "osuPrefix": "string"
      },
      "imageExport": {
        "imageId": "string"
      },
      "imageExportTaskId": "string",
      "state": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

DescribeImagesRequest

Property	Type	Description
ExecutableBy	[string]	The account IDs which have launch permissions for the OMIs.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeImages \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
ImageId	[string]	One or more OMI IDs.
Owner	[string]	The account ID of one or more owners of OMIs. By default, all the OMIs for which you have launch permissions are described.

{
  "ExecutableBy": [
    "string"
  ],
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "ImageId": [
    "string"
  ],
  "Owner": [
    "string"
  ]
}

DescribeImagesResponse

Property	Type	Description
imagesSet	[imagesSet]	Information about one or more OMIs.
requestId	string	The ID of the request.

{
  "imagesSet": [
    {
      "architecture": "string",
      "blockDeviceMapping": [
        {
          "deviceName": "string",
          "ebs": {
            "deleteOnTermination": true,
            "iops": 0,
            "snapshotId": "string",
            "volumeSize": 0,
            "volumeType": "string"
          },
          "noDevice": "string",
          "virtualName": "string"
        }
      ],
      "description": "string",
      "hypervisor": "string",
      "imageId": "string",
      "imageLocation": "string",
      "imageOwnerAlias": "string",
      "imageOwnerId": "string",
      "imageState": "string",
      "imageType": "string",
      "isPublic": true,
      "name": "string",
      "platform": "string",
      "productCodes": [
        {
          "productCode": "string",
          "type": "string"
        }
      ],
      "rootDeviceName": "string",
      "rootDeviceType": "string",
      "stateReason": {
        "code": "string",
        "message": "string"
      },
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "virtualizationType": "string"
    }
  ],
  "requestId": "string"
}

DescribeInstanceAttributeRequest

Property	Type	Description
Attribute	string	The instance attribute (`ramdisk` \| `userData` \| `instanceInitiatedShutdownBehavior` \| `rootDeviceName` \| `instanceType` \| `blockDeviceMapping` \| `groupSet` \| `sourceDestCheck` \| `disableApiTermination`).
InstanceId	string	The ID of the instance.

{
  "Attribute": "string",
  "InstanceId": "string"
}

DescribeInstanceAttributeResponse

Property	Type	Description
blockDeviceMapping	[BlockDeviceMapping_3]	The block device mapping of the instance.
disableApiTermination	DisableApiTermination_1	If true, you cannot terminate the instance unless you change this parameter back to false.
ebsOptimized	EbsOptimized_1	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
groupSet	[groupSet]	The security groups associated with the instance.
instanceId	string	The ID of the instance.
instanceInitiatedShutdownBehavior	InstanceInitiatedShutdownBehavior_1	Indicates whether the instance stops, terminates or restarts when you stop or terminate it.
instanceType	InstanceType_1	The type of instance. For more information, see VM-Types.html">VM Types.
ramdisk	ramdisk	The ID of the RAM disk.
requestId	string	The ID of the request.
rootDeviceName	rootDeviceName	The name of the root device.
sourceDestCheck	SourceDestCheck_1	(VPC only) If true, the source/destination check is enabled. If false, it is disabled.
userData	UserData_1	The Base64-encoded MIME user data.

{
  "blockDeviceMapping": [
    {
      "deviceName": "string",
      "ebs": {
        "attachTime": "string",
        "deleteOnTermination": true,
        "status": "string",
        "volumeId": "string"
      }
    }
  ],
  "disableApiTermination": {
    "value": true
  },
  "ebsOptimized": {
    "value": true
  },
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "instanceId": "string",
  "instanceInitiatedShutdownBehavior": {
    "value": "string"
  },
  "instanceType": {
    "value": "string"
  },
  "ramdisk": {
    "Value": "string"
  },
  "requestId": "string",
  "rootDeviceName": {
    "Value": "string"
  },
  "sourceDestCheck": {
    "value": true
  },
  "userData": {
    "value": "string"
  }
}

DescribeInstanceStatusRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeInstanceStatus \` `--Filter.1.Name "availability-zone" \` `--Filter.1.Value.1 "eu-west-2a"`
IncludeAllInstances	boolean	If set to true, includes the status of all instances. By default or if set to false, only includes the status of running instances.
InstanceId	[string]	One or more instance IDs.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned. You cannot specify both this parameter and the InstanceId parameter in the same request.
NextToken	string	The token to request the next results page.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "IncludeAllInstances": true,
  "InstanceId": [
    "string"
  ],
  "MaxResults": 0,
  "NextToken": "string"
}

DescribeInstanceStatusResponse

Property	Type	Description
instanceStatusSet	[instanceStatusSet]	One or more instance status descriptions.
nextToken	string	The token to request the next results page. If the value is null, there is no results left to be returned.
requestId	string	The ID of the request.

{
  "instanceStatusSet": [
    {
      "availabilityZone": "string",
      "eventsSet": [
        {
          "code": "string",
          "description": "string",
          "notAfter": "string",
          "notBefore": "string"
        }
      ],
      "instanceId": "string",
      "instanceState": {
        "code": 0,
        "name": "string"
      },
      "instanceStatus": {
        "details": [
          {
            "impairedSince": "string",
            "name": "string",
            "status": "string"
          }
        ],
        "status": "string"
      },
      "systemStatus": {
        "details": [
          {
            "impairedSince": "string",
            "name": "string",
            "status": "string"
          }
        ],
        "status": "string"
      }
    }
  ],
  "nextToken": "string",
  "requestId": "string"
}

DescribeInstanceTypesRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeInstanceTypes \` `--Filter.1.Name "description" \` `--Filter.1.Value.1 "Windows"`

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ]
}

DescribeInstanceTypesResponse

Property	Type	Description
instanceTypeSet	[instanceTypeSet]	One or more instance types.
requestId	string	The ID of the request.

{
  "instanceTypeSet": [
    {
      "ebsOptimizedAvailable": true,
      "ephemeralsType": "string",
      "eth": 0,
      "gpu": 0,
      "maxIpAddresses": 0,
      "memory": 0,
      "name": "string",
      "storageCount": 0,
      "storageSize": 0,
      "vcpu": 0
    }
  ],
  "requestId": "string"
}

DescribeInstancesRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeInstances \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
InstanceId	[string]	One or more instance IDs.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use NextToken to retrieve next results pages. This value is in between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned. You cannot specify both this parameter and the InstanceId parameter in the same request.
NextToken	string	The token to request the next results page.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "InstanceId": [
    "string"
  ],
  "MaxResults": 0,
  "NextToken": "string"
}

DescribeInstancesResponse

Property	Type	Description
nextToken	string	The token to specify to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.
reservationSet	[reservationSet]	Zero or more reservations.

{
  "nextToken": "string",
  "requestId": "string",
  "reservationSet": [
    {
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "instancesSet": [
        {
          "amiLaunchIndex": 0,
          "architecture": "string",
          "blockDeviceMapping": [
            {
              "deviceName": "string",
              "ebs": {
                "attachTime": "string",
                "deleteOnTermination": true,
                "status": "string",
                "volumeId": "string"
              }
            }
          ],
          "clientToken": "string",
          "dnsName": "string",
          "ebsOptimized": true,
          "groupSet": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "hypervisor": "string",
          "iamInstanceProfile": {
            "arn": "string",
            "id": "string"
          },
          "imageId": "string",
          "instanceId": "string",
          "instanceLifecycle": "string",
          "instanceState": {
            "code": 0,
            "name": "string"
          },
          "instanceType": "string",
          "ipAddress": "string",
          "kernelId": "string",
          "keyName": "string",
          "launchTime": "string",
          "monitoring": {
            "state": "string"
          },
          "networkInterfaceSet": [
            {
              "association": {
                "ipOwnerId": "string",
                "publicDnsName": "string",
                "publicIp": "string"
              },
              "attachment": {
                "attachTime": "string",
                "attachmentId": "string",
                "deleteOnTermination": true,
                "deviceIndex": 0,
                "status": "string"
              },
              "description": "string",
              "groupSet": [
                {
                  "groupId": "string",
                  "groupName": "string"
                }
              ],
              "macAddress": "string",
              "networkInterfaceId": "string",
              "ownerId": "string",
              "privateDnsName": "string",
              "privateIpAddress": "string",
              "privateIpAddressesSet": [
                {
                  "association": {
                    "ipOwnerId": "string",
                    "publicDnsName": "string",
                    "publicIp": "string"
                  },
                  "primary": true,
                  "privateDnsName": "string",
                  "privateIpAddress": "string"
                }
              ],
              "sourceDestCheck": true,
              "status": "string",
              "subnetId": "string",
              "vpcId": "string"
            }
          ],
          "placement": {
            "availabilityZone": "string",
            "groupName": "string",
            "tenancy": "string"
          },
          "platform": "string",
          "privateDnsName": "string",
          "privateIpAddress": "string",
          "productCodes": [
            {
              "productCode": "string",
              "type": "string"
            }
          ],
          "ramdiskId": "string",
          "reason": "string",
          "rootDeviceName": "string",
          "rootDeviceType": "string",
          "sourceDestCheck": true,
          "spotInstanceRequestId": "string",
          "sriovNetSupport": "string",
          "stateReason": {
            "code": "string",
            "message": "string"
          },
          "subnetId": "string",
          "tagSet": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "virtualizationType": "string",
          "vpcId": "string"
        }
      ],
      "ownerId": "string",
      "requesterId": "string",
      "reservationId": "string"
    }
  ]
}

DescribeInternetGatewaysRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeInternetGateways \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
InternetGatewayId	[string]	One or more internet gateways IDs.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "InternetGatewayId": [
    "string"
  ]
}

DescribeInternetGatewaysResponse

Property	Type	Description
internetGatewaySet	[internetGatewaySet]	Information about one or more internet gateways.
requestId	string	The ID of the request.

{
  "internetGatewaySet": [
    {
      "attachmentSet": [
        {
          "state": "string",
          "vpcId": "string"
        }
      ],
      "internetGatewayId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "requestId": "string"
}

DescribeKeyPairsRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeKeyPairs \` `--Filter.1.Name "key-name" \` `--Filter.1.Value.1 "Keypair1"`
KeyName	[string]	One or more keypair names.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "KeyName": [
    "string"
  ]
}

DescribeKeyPairsResponse

Property	Type	Description
keySet	[keySet]	Information about one or more keypairs.
requestId	string	The ID of the request.

{
  "keySet": [
    {
      "keyFingerprint": "string",
      "keyName": "string"
    }
  ],
  "requestId": "string"
}

DescribeNatGatewaysRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeNatGateways \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use NextToken to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NatGatewayId	[string]	One or more IDs of NAT gateways.
NextToken	string	The token to request the next results page.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "MaxResults": 0,
  "NatGatewayId": [
    "string"
  ],
  "NextToken": "string"
}

DescribeNatGatewaysResponse

Property	Type	Description
natGatewaySet	[natGatewaySet]	Information about one or more NAT gateways.
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.

{
  "natGatewaySet": [
    {
      "createTime": "string",
      "deleteTime": "string",
      "natGatewayAddressSet": [
        {
          "allocationId": "string",
          "networkInterfaceId": "string",
          "privateIp": "string",
          "publicIp": "string"
        }
      ],
      "natGatewayId": "string",
      "state": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ],
  "nextToken": "string",
  "requestId": "string"
}

DescribeNetworkInterfacesRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeNetworkInterfaces \` `--Filter.1.Name "network-interface-id" \` `--Filter.1.Value.1 "eni-12345678"`
NetworkInterfaceId	[string]	One or more FNI IDs.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "NetworkInterfaceId": [
    "string"
  ]
}

DescribeNetworkInterfacesResponse

Property	Type	Description
networkInterfaceSet	[networkInterfaceSet_1]	Information about the FNIs.
requestId	string	The ID of the request.

{
  "networkInterfaceSet": [
    {
      "association": {
        "allocationId": "string",
        "associationId": "string",
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "attachment": {
        "attachTime": "string",
        "attachmentId": "string",
        "deleteOnTermination": true,
        "deviceIndex": 0,
        "instanceId": "string",
        "instanceOwnerId": "string",
        "status": "string"
      },
      "availabilityZone": "string",
      "description": "string",
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "macAddress": "string",
      "networkInterfaceId": "string",
      "ownerId": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "privateIpAddressesSet": [
        {
          "association": {
            "allocationId": "string",
            "associationId": "string",
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "primary": true,
          "privateDnsName": "string",
          "privateIpAddress": "string"
        }
      ],
      "sourceDestCheck": true,
      "status": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ],
  "requestId": "string"
}

DescribePrefixListsRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribePrefixLists \` `--Filter.1.Name "prefix-list-id" \` `--Filter.1.Value.1 "pl-12345678"`
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use `NextToken` to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NextToken	string	The token to request the next results page.
PrefixListId	[string]	One or more prefix list IDs.

{
  "DryRun": true,
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "MaxResults": 0,
  "NextToken": "string",
  "PrefixListId": [
    "string"
  ]
}

DescribePrefixListsResponse

Property	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
prefixListSet	[prefixListSet]	Information about one or more prefix lists.
requestId	string	The ID of the request.

{
  "nextToken": "string",
  "prefixListSet": [
    {
      "cidrSet": [
        "string"
      ],
      "prefixListId": "string",
      "prefixListName": "string"
    }
  ],
  "requestId": "string"
}

DescribeProductTypesRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeProductTypes \` `--Filter.1.Name "description" \` `--Filter.1.Value.1 "Windows"`

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ]
}

DescribeProductTypesResponse

Property	Type	Description
productTypeSet	[productTypeSet]	One or more product types.
requestId	string	The ID of the request.

{
  "productTypeSet": [
    {
      "description": "string",
      "productTypeId": "string",
      "vendor": "string"
    }
  ],
  "requestId": "string"
}

DescribeQuotasRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeQuotas \` `--Filter.1.Name "quota.display-name" \` `--Filter.1.Value.1 "DisplayName"`
MaxResults	integer	The maximum number of items that can be returned in a single page (by default, `100`).
NextToken	string	The token to request the next results page.
QuotaName	[string]	One or more names of quotas.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "MaxResults": 0,
  "NextToken": "string",
  "QuotaName": [
    "string"
  ]
}

DescribeQuotasResponse

Property	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there are no results left to be returned.
referenceQuotaSet	[referenceQuotaSet]	One or more reference quotas.
requestId	string	The ID of the request.

{
  "nextToken": "string",
  "referenceQuotaSet": [
    {
      "quotaSet": [
        {
          "description": "string",
          "displayName": "string",
          "groupName": "string",
          "maxQuotaValue": 0,
          "name": "string",
          "ownerId": "string",
          "usedQuotaValue": 0
        }
      ],
      "reference": "string"
    }
  ],
  "requestId": "string"
}

DescribeRegionsRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeRegions \` `--Filter.1.Name "region-name" \` `--Filter.1.Value.1 "eu-west-2"`
RegionName	[string]	The name of one or more Regions.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "RegionName": [
    "string"
  ]
}

DescribeRegionsResponse

Property	Type	Description
regionInfo	[regionInfo]	Information about one or more Regions.
requestId	string	The ID of the request.

{
  "regionInfo": [
    {
      "regionEndpoint": "string",
      "regionName": "string"
    }
  ],
  "requestId": "string"
}

DescribeRouteTablesRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeRouteTables \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
RouteTableId	[string]	One or more route table IDs.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "RouteTableId": [
    "string"
  ]
}

DescribeRouteTablesResponse

Property	Type	Description
requestId	string	The ID of the request.
routeTableSet	[routeTableSet]	Information about one or more route tables.

{
  "requestId": "string",
  "routeTableSet": [
    {
      "associationSet": [
        {
          "main": true,
          "routeTableAssociationId": "string",
          "routeTableId": "string",
          "subnetId": "string"
        }
      ],
      "propagatingVgwSet": [
        {
          "gatewayId": "string"
        }
      ],
      "routeSet": [
        {
          "destinationCidrBlock": "string",
          "destinationPrefixListId": "string",
          "gatewayId": "string",
          "instanceId": "string",
          "instanceOwnerId": "string",
          "networkInterfaceId": "string",
          "origin": "string",
          "state": "string",
          "vpcPeeringConnectionId": "string"
        }
      ],
      "routeTableId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

DescribeSecurityGroupsRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeSecurityGroups \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
GroupId	[string]	The ID of one or more security groups.
GroupName	[string]	The name of one or more security groups. This parameter only matches security groups in the public Cloud. To match security groups in a VPC, use the `group-name` filter instead.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "GroupId": [
    "string"
  ],
  "GroupName": [
    "string"
  ]
}

DescribeSecurityGroupsResponse

Property	Type	Description
requestId	string	The ID of the request.
securityGroupInfo	[securityGroupInfo]	Information about one or more security groups.

{
  "requestId": "string",
  "securityGroupInfo": [
    {
      "groupDescription": "string",
      "groupId": "string",
      "groupName": "string",
      "ipPermissions": [
        {
          "fromPort": 0,
          "groups": [
            {
              "groupId": "string",
              "groupName": "string",
              "userId": "string"
            }
          ],
          "ipProtocol": "string",
          "ipRanges": [
            {
              "cidrIp": "string"
            }
          ],
          "prefixListIds": [
            {
              "prefixListId": "string"
            }
          ],
          "toPort": 0
        }
      ],
      "ipPermissionsEgress": [
        {
          "fromPort": 0,
          "groups": [
            {
              "groupId": "string",
              "groupName": "string",
              "userId": "string"
            }
          ],
          "ipProtocol": "string",
          "ipRanges": [
            {
              "cidrIp": "string"
            }
          ],
          "prefixListIds": [
            {
              "prefixListId": "string"
            }
          ],
          "toPort": 0
        }
      ],
      "ownerId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

DescribeSnapshotAttributeRequest

Property	Type	Description
Attribute	string	The snapshot attribute (always `createVolumePermission`).
SnapshotId	string	The ID of the snapshot.

{
  "Attribute": "string",
  "SnapshotId": "string"
}

DescribeSnapshotAttributeResponse

Property	Type	Description
createVolumePermission	[CreateVolumePermission_1]	A list of permissions for creating volumes from the snapshot.
requestId	string	The ID of the request.
snapshotId	string	The ID of the snapshot.

{
  "createVolumePermission": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ],
  "requestId": "string",
  "snapshotId": "string"
}

DescribeSnapshotExportTasksRequest

Property	Type	Description
SnapshotExportTaskId	[string]	One or more snapshot export tasks IDs.

{
  "SnapshotExportTaskId": [
    "string"
  ]
}

DescribeSnapshotExportTasksResponse

Property	Type	Description
requestId	string	The ID of the request.
snapshotExportTaskSet	[snapshotExportTask]	Information about one or more snapshot export tasks.

{
  "requestId": "string",
  "snapshotExportTaskSet": [
    {
      "completion": 0,
      "exportToOsu": {
        "diskImageFormat": "string",
        "osuBucket": "string",
        "osuKey": "string",
        "osuPrefix": "string",
        "aksk": {
          "AccessKey": "string",
          "SecretKey": "string"
        }
      },
      "snapshotExport": {
        "snapshotId": "string"
      },
      "snapshotExportTaskId": "string",
      "state": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}

DescribeSnapshotsRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeSnapshots \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use `NextToken` to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NextToken	string	The token to request the next results page.
Owner	[string]	One or more owners of the snapshots.
RestorableBy	[string]	One or more accounts IDs that have the permissions to create volumes from the snapshot.
SnapshotId	[string]	One or more snapshot IDs.

{
  "DryRun": true,
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "MaxResults": 0,
  "NextToken": "string",
  "Owner": [
    "string"
  ],
  "RestorableBy": [
    "string"
  ],
  "SnapshotId": [
    "string"
  ]
}

DescribeSnapshotsResponse

Property	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.
snapshotSet	[snapshotSet]	Information about one or more snapshots.

{
  "nextToken": "string",
  "requestId": "string",
  "snapshotSet": [
    {
      "description": "string",
      "encrypted": true,
      "ownerAlias": "string",
      "ownerId": "string",
      "progress": "string",
      "snapshotId": "string",
      "startTime": "string",
      "status": "string",
      "statusMessage": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "volumeId": "string",
      "volumeSize": 0
    }
  ]
}

DescribeSubnetsRequest

Property	Type	Description
Filter	[Filter]	One or more filters.
SubnetId	[string]	One or more subnet IDs.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "SubnetId": [
    "string"
  ]
}

DescribeSubnetsResponse

Property	Type	Description
requestId	string	The ID of the request.
subnetSet	[subnetSet]	Information about one or more of your subnets.

{
  "requestId": "string",
  "subnetSet": [
    {
      "availabilityZone": "string",
      "availableIpAddressCount": 0,
      "cidrBlock": "string",
      "mapPublicIpOnLaunch": true,
      "state": "string",
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

DescribeTagsRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeTags \` `--Filter.1.Name "resource-id" \` `--Filter.1.Value.1 "i-12345678"`
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use the `NextToken` attribute to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NextToken	string	The token to request the next results page.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "MaxResults": 0,
  "NextToken": "string"
}

DescribeTagsResponse

Property	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.
tagSet	[tagSet_1]	Information about one or more tags.

{
  "nextToken": "string",
  "requestId": "string",
  "tagSet": [
    {
      "key": "string",
      "resourceId": "string",
      "resourceType": "string",
      "value": "string"
    }
  ]
}

DescribeVolumesRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVolumes \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use the `NextToken` attribute to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NextToken	string	The token to request the next results page.
VolumeId	[string]	One or more volume IDs.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "MaxResults": 0,
  "NextToken": "string",
  "VolumeId": [
    "string"
  ]
}

DescribeVolumesResponse

Property	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.
volumeSet	[volumeSet]	Information about one or more volumes.

{
  "nextToken": "string",
  "requestId": "string",
  "volumeSet": [
    {
      "attachmentSet": [
        {
          "attachTime": "string",
          "deleteOnTermination": true,
          "device": "string",
          "instanceId": "string",
          "status": "string",
          "volumeId": "string"
        }
      ],
      "availabilityZone": "string",
      "createTime": "string",
      "iops": 0,
      "size": 0,
      "snapshotId": "string",
      "status": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "volumeId": "string",
      "volumeType": "string"
    }
  ]
}

DescribeVpcAttributeRequest

Property	Type	Description
Attribute	string	The attribute name (`enableDnsSupport` or `enableDnsHostnames`).
VpcId	string	The ID of the VPC.

{
  "Attribute": "string",
  "VpcId": "string"
}

DescribeVpcAttributeResponse

Property	Type	Description
enableDnsHostnames	EnableDnsHostnames_1	The state of the `enableDnsHostnames` attribute.
enableDnsSupport	EnableDnsSupport_1	The state of the `enableDnsSupport` attribute.
requestId	string	The ID of the request.
vpcId	string	The ID of the VPC.

{
  "enableDnsHostnames": {
    "value": true
  },
  "enableDnsSupport": {
    "value": true
  },
  "requestId": "string",
  "vpcId": "string"
}

DescribeVpcEndpointServicesRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
MaxResults	integer	The maximum number of results that can be returned in a single page. You can use the `NextToken` attribute to request the next results pages. This value is between `5` and `1000`. If you provide a value larger than 1000, only 1000 results are returned.
NextToken	string	The token to request the next results page.

{
  "DryRun": true,
  "MaxResults": 0,
  "NextToken": "string"
}

DescribeVpcEndpointServicesResponse

Property	Type	Description
nextToken	string	The token to request the next results page. If the value is `null`, there is no results left to be returned.
requestId	string	The ID of the request.
serviceNameSet	[string]	The names of the services you can use for VPC endpoints.

{
  "nextToken": "string",
  "requestId": "string",
  "serviceNameSet": [
    "string"
  ]
}

DescribeVpcEndpointsRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpcEndpoints \` `--Filter.1.Name "vpc-endpoint-id" \` `--Filter.1.Value.1 "vpce-12345678"`
VpcEndpointId	[string]	One or more IDs of VPC endpoints.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "VpcEndpointId": [
    "string"
  ]
}

DescribeVpcEndpointsResponse

Property	Type	Description
requestId	string	The ID of the request.
vpcEndpointSet	[vpcEndpointSet]	Information about one or more VPC endpoints.

{
  "requestId": "string",
  "vpcEndpointSet": [
    {
      "creationTimestamp": "string",
      "routeTableIdSet": [
        "string"
      ],
      "serviceName": "string",
      "state": "string",
      "vpcEndpointId": "string",
      "vpcId": "string"
    }
  ]
}

DescribeVpcPeeringConnectionsRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpcPeeringConnections \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
VpcPeeringConnectionId	[string]	One or more VPC peering connection IDs.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "VpcPeeringConnectionId": [
    "string"
  ]
}

DescribeVpcPeeringConnectionsResponse

Property	Type	Description
requestId	string	The ID of the request.
vpcPeeringConnectionSet	[vpcPeeringConnectionSet]	Information about one or more VPC peering connections.

{
  "requestId": "string",
  "vpcPeeringConnectionSet": [
    {
      "accepterVpcInfo": {
        "cidrBlock": "string",
        "ownerId": "string",
        "vpcId": "string"
      },
      "expirationTime": "string",
      "requesterVpcInfo": {
        "cidrBlock": "string",
        "ownerId": "string",
        "vpcId": "string"
      },
      "status": {
        "code": "string",
        "message": "string"
      },
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcPeeringConnectionId": "string"
    }
  ]
}

DescribeVpcsRequest

Property	Type	Description
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpcs \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
VpcId	[string]	One or more VPC IDs.

{
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "VpcId": [
    "string"
  ]
}

DescribeVpcsResponse

Property	Type	Description
requestId	string	The ID of the request.
vpcSet	[vpcSet]	Information about one or more VPCs.

{
  "requestId": "string",
  "vpcSet": [
    {
      "cidrBlock": "string",
      "dhcpOptionsId": "string",
      "isDefault": true,
      "instanceTenancy": "string",
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "vpcId": "string"
    }
  ]
}

DescribeVpnConnectionsRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpnConnections \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
VpnConnectionId	[string]	One or more VPN connections IDs.

{
  "DryRun": true,
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "VpnConnectionId": [
    "string"
  ]
}

DescribeVpnConnectionsResponse

Property	Type	Description
requestId	string	The ID of the request.
vpnConnectionSet	[vpnConnectionSet]	Information about one or more VPN connections.

{
  "requestId": "string",
  "vpnConnectionSet": [
    {
      "customerGatewayConfiguration": "string",
      "customerGatewayId": "string",
      "options": {
        "staticRoutesOnly": true
      },
      "routes": [
        {
          "destinationCidrBlock": "string",
          "source": "string",
          "state": "string"
        }
      ],
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string",
      "vgwTelemetry": [
        {
          "acceptedRouteCount": 0,
          "lastStatusChange": "string",
          "outsideIpAddress": "string",
          "status": "string",
          "statusMessage": "string"
        }
      ],
      "vpnConnectionId": "string",
      "vpnGatewayId": "string"
    }
  ]
}

DescribeVpnGatewaysRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Filter	[Filter]	One or more filters. Example: `osc-cli fcu DescribeVpnGateways \` `--Filter.1.Name "tag:KEYOFTHETAG" \` `--Filter.1.Value.1 "VALUEOFTHETAG"`
VpnGatewayId	[string]	One or more virtual private gateways.

{
  "DryRun": true,
  "Filter": [
    {
      "Name": "string",
      "Value": [
        "string"
      ]
    }
  ],
  "VpnGatewayId": [
    "string"
  ]
}

DescribeVpnGatewaysResponse

Property	Type	Description
requestId	string	The ID of the request.
vpnGatewaySet	[vpnGatewaySet]	Information about one or more virtual private gateways.

{
  "requestId": "string",
  "vpnGatewaySet": [
    {
      "attachments": [],
      "state": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "type": "string",
      "vpnGatewayId": "string"
    }
  ]
}

Description_0

A new description of the resource.

Property	Type	Description
Value	string	The value specified for the resource attribute.

{
  "Value": "string"
}

Description_1

The description of the resource.

Property	Type	Description
value	string	The value specified for the resource attribute.

{
  "value": "string"
}

DetachInternetGatewayRequest

Property	Type	Description
InternetGatewayId	string	The ID of the internet gateway.
VpcId	string	The ID of the VPC.

{
  "InternetGatewayId": "string",
  "VpcId": "string"
}

DetachInternetGatewayResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DetachNetworkInterfaceRequest

Property	Type	Description
AttachmentId	string	The ID of the attachment operation.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.

{
  "AttachmentId": "string",
  "DryRun": true
}

DetachNetworkInterfaceResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DetachVolumeRequest

Property	Type	Description
Device	string	The name of the device.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
Force	boolean	Forces the detachment of the volume in case of previous failure (this action may damage your data or file systems).
InstanceId	string	The ID of the instance.
VolumeId	string	The ID of the volume.

{
  "Device": "string",
  "DryRun": true,
  "Force": true,
  "InstanceId": "string",
  "VolumeId": "string"
}

DetachVolumeResponse

Property	Type	Description
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
device	string	The name of the device.
instanceId	string	The ID of the instance.
requestId	string	The ID of the request.
status	string	The attachment state of the volume (`attaching` \| `detaching` \| `attached` \| `detached`).
volumeId	string	The ID of the volume.

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "requestId": "string",
  "status": "string",
  "volumeId": "string"
}

DetachVpnGatewayRequest

Property	Type	Description
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
VpcId	string	The ID of the VPC.
VpnGatewayId	string	The ID of the virtual private gateway.

{
  "DryRun": true,
  "VpcId": "string",
  "VpnGatewayId": "string"
}

DetachVpnGatewayResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

details

The system instance health or application instance health.

Property	Type	Description
impairedSince	string	The time at which a state check failed (for an instance that was launched and impaired, the time at which the instance was launched).
name	string	The type of instance state (always `reachability`).
status	string	The state of the instance.

{
  "impairedSince": "string",
  "name": "string",
  "status": "string"
}

DhcpConfiguration

A DHCP configuration option.

Property	Type	Description
Key	string	The type of DHCP option (`domain-name-servers` \| `domain-name` \| `ntp-servers` \| `log-servers`). For more information, see About DHCP Options.
Value	[string]	The values for the DHCP option (one to four IPs for the `domain-name-servers`, `ntp-servers` and `log-servers` options, or a domain name for the `domain-name` option). For more information, see About DHCP Options.

{
  "Key": "string",
  "Value": [
    "string"
  ]
}

DisableApiTermination_0

If true, you cannot terminate the instance unless you change this parameter back to false.

Property	Type	Description
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "Value": true
}

DisableApiTermination_1

If true, you cannot terminate the instance unless you change this parameter back to false.

Property	Type	Description
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "value": true
}

DisableVgwRoutePropagationRequest

Property	Type	Description
GatewayId	string	The ID of the virtual private gateway.
RouteTableId	string	The ID of the route table.

{
  "GatewayId": "string",
  "RouteTableId": "string"
}

DisableVgwRoutePropagationResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DisassociateAddressRequest

Property	Type	Description
AssociationId	string	The ID that represents the association of the EIP with the instance or the network interface (required in a VPC).
PublicIp	string	The EIP (required in the public Cloud).

{
  "AssociationId": "string",
  "PublicIp": "string"
}

DisassociateAddressResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

DisassociateRouteTableRequest

Property	Type	Description
AssociationId	string	The ID of the current association between the route table and the subnet.

{
  "AssociationId": "string"
}

DisassociateRouteTableResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

EbsOptimized_0

This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.

Property	Type	Description
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "Value": true
}

EbsOptimized_1

This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.

Property	Type	Description
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "value": true
}

Ebs_0

One or more parameters to map a volume to DeviceName at launch. You can specify either Ebs or VirtualName, but not both.

Property	Type	Description
DeleteOnTermination	boolean	By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
Iops	integer	The number of I/O operations per second. This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
SnapshotId	string	The ID of the snapshot used to create the volume.
VolumeSize	integer	The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
VolumeType	string	The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created. For more information about volumes types, see Volume Types and IOPS.

{
  "DeleteOnTermination": true,
  "Iops": 0,
  "SnapshotId": "string",
  "VolumeSize": 0,
  "VolumeType": "string"
}

Ebs_1

One or more parameters used to automatically set up volumes when you launch the instance.

Property	Type	Description
DeleteOnTermination	boolean	By default or if set to true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
VolumeId	string	The ID of the volume.

{
  "DeleteOnTermination": true,
  "VolumeId": "string"
}

Ebs_2

One or more parameters used to automatically set up volumes when you launch the instance.

Property	Type	Description
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
iops	integer	The number of I/O operations per second. This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
snapshotId	string	The ID of the snapshot used to create the volume.
volumeSize	integer	The size of the volume, in gibibytes (GiB). If you specify a snapshot ID, the volume size must be at least equal to the snapshot size. If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
volumeType	string	The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created. For more information about volumes types, see Volume Types and IOPS.

{
  "deleteOnTermination": true,
  "iops": 0,
  "snapshotId": "string",
  "volumeSize": 0,
  "volumeType": "string"
}

EnableDnsHostnames_0

If set to true, instances launched in the VPC get DNS hostnames (by default, true).

Property	Type	Description
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "Value": true
}

EnableDnsHostnames_1

The state of the enableDnsHostnames attribute.

Property	Type	Description
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "value": true
}

EnableDnsSupport_0

If set to true, DNS resolution is supported for the VPC (by default, true).

Property	Type	Description
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "Value": true
}

EnableDnsSupport_1

The state of the enableDnsSupport attribute.

Property	Type	Description
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "value": true
}

EnableVgwRoutePropagationRequest

Property	Type	Description
GatewayId	string	The ID of the virtual private gateway.
RouteTableId	string	The ID of the route table.

{
  "GatewayId": "string",
  "RouteTableId": "string"
}

EnableVgwRoutePropagationResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

ExportToOsu_0

Information about the OMI export task.

Property	Type	Description
DiskImageFormat	string	The format of the export disk (`qcow2` \| `raw`).
OsuAkSk	OsuAkSk	The access key and secret key of the OOS account used to access the bucket.
OsuBucket	string	The name of the OOS bucket where you want to export the OMI.
OsuPrefix	string	The prefix for the key of the OOS object corresponding to the image.

{
  "DiskImageFormat": "string",
  "OsuAkSk": {
    "AccessKey": "string",
    "SecretKey": "string"
  },
  "OsuBucket": "string",
  "OsuPrefix": "string"
}

ExportToOsu_1

Information about the snapshot export task.

Property	Type	Description
DiskImageFormat	string	The format of the export disk (`qcow2` \| `raw`).
OsuBucket	string	The name of the OOS bucket where you want to export the snapshot.
OsuPrefix	string	The prefix for the key of the OOS object corresponding to the snapshot.
aksk	aksk	The access key and secret key of the OOS account used to access the bucket.

{
  "DiskImageFormat": "string",
  "OsuBucket": "string",
  "OsuPrefix": "string",
  "aksk": {
    "AccessKey": "string",
    "SecretKey": "string"
  }
}

exportToOsu_2

Information about the OMI export task.

Property	Type	Description
diskImageFormat	string	The format of the export disk (`qcow2` \| `raw`).
osuAkSk	OsuAkSk	The access key and secret key of the OOS account used to access the bucket.
osuBucket	string	The name of the OOS bucket where the OMI is exported.
osuManifestUrl	string	The URL of the manifest file.
osuPrefix	string	The prefix for the key of the OOS object corresponding to the image.

{
  "diskImageFormat": "string",
  "osuAkSk": {
    "AccessKey": "string",
    "SecretKey": "string"
  },
  "osuBucket": "string",
  "osuManifestUrl": "string",
  "osuPrefix": "string"
}

exportToOsu_3

Information about the snapshot export task.

Property	Type	Description
diskImageFormat	string	The format of the export disk (`qcow2` \| `raw`).
osuBucket	string	The name of the OOS bucket where the snapshot is exported.
osuKey	string	The key of the OOS object corresponding to the snapshot.
osuPrefix	string	The prefix for the key of the OOS object corresponding to the snapshot.
aksk	aksk	The access key and secret key of the OOS account used to access the bucket.

{
  "diskImageFormat": "string",
  "osuBucket": "string",
  "osuKey": "string",
  "osuPrefix": "string",
  "aksk": {
    "AccessKey": "string",
    "SecretKey": "string"
  }
}

Filter

One or more filters.

Property	Type	Description
Name	string	The name of the filter.
Value	[string]	One or more filter values.

{
  "Name": "string",
  "Value": [
    "string"
  ]
}

GetConsoleOutputRequest

Property	Type	Description
InstanceId	string	The ID of the instance.

{
  "InstanceId": "string"
}

GetConsoleOutputResponse

Property	Type	Description
instanceId	string	The ID of the instance.
output	string	The Base64 encoded output of the console. If a command line tool is used, the output is decoded by the tools.
requestId	string	The ID of the request.
timestamp	string	The date and time the output was last updated, in ISO 8601 format.

{
  "instanceId": "string",
  "output": "string",
  "requestId": "string",
  "timestamp": "string"
}

GetPasswordDataRequest

Property	Type	Description
InstanceId	string	The ID of the instance.

{
  "InstanceId": "string"
}

GetPasswordDataResponse

Property	Type	Description
instanceId	string	The ID of the instance.
passwordData	string	The password of the instance. After the first boot, returns an empty string.
requestId	string	The ID of the request.
timestamp	string	The date and time the output was last updated, in ISO 8601 format.

{
  "instanceId": "string",
  "passwordData": "string",
  "requestId": "string",
  "timestamp": "string"
}

GetProductTypeRequest

Property	Type	Description
ImageId	string	The ID of the OMI.
SnapshotId	string	The ID of the snapshot.

{
  "ImageId": "string",
  "SnapshotId": "string"
}

GetProductTypeResponse

Property	Type	Description
productType	productType	Information about the product type of the specified OMI or snapshot.
requestId	string	The ID of the request.

{
  "productType": {
    "description": "string",
    "productTypeId": "string",
    "vendor": "string"
  },
  "requestId": "string"
}

GetProductTypesRequest

Property	Type	Description
ImageId	string	The ID of the OMI.
SnapshotId	string	The ID of the snapshot.

{
  "ImageId": "string",
  "SnapshotId": "string"
}

GetProductTypesResponse

Property	Type	Description
productTypeSet	[productTypeSet]	Information about one or more product types.
requestId	string	The ID of the request.

{
  "productTypeSet": [
    {
      "description": "string",
      "productTypeId": "string",
      "vendor": "string"
    }
  ],
  "requestId": "string"
}

Groups_0

One or more security groups and account ID pairs.

Property	Type	Description
GroupId	string	The ID of the security group (in case of a security group in a nondefault VPC).
GroupName	string	The name of the security group (in case of a security group in FCU or a default VPC).
UserId	string	The ID of the account.

{
  "GroupId": "string",
  "GroupName": "string",
  "UserId": "string"
}

Groups_1

Information about one or more security groups associated with the FNI.

Property	Type	Description
groupId	string	The ID of the security group.xx
groupName	string	The name of the security group.

{
  "groupId": "string",
  "groupName": "string"
}

groups_2

One or more security groups and account ID pairs.

Property	Type	Description
groupId	string	The ID of the security group (in case of a security group in a nondefault VPC).
groupName	string	The name of the security group (in case of a security group in FCU or a default VPC).
userId	string	The ID of the account.

{
  "groupId": "string",
  "groupName": "string",
  "userId": "string"
}

ImportKeyPairRequest

Property	Type	Description
KeyName	string	A unique name for the keypair, with a maximum length of 255 ASCII printable characters.
PublicKeyMaterial	string	The public key. It must be Base64-encoded.

{
  "KeyName": "string",
  "PublicKeyMaterial": "string"
}

ImportKeyPairResponse

Property	Type	Description
keyFingerprint	string	The MD5 public key fingerprint as specified in section 4 of RFC 4716.
keyName	string	The keypair name you specified.
requestId	string	The ID of the request.

{
  "keyFingerprint": "string",
  "keyName": "string",
  "requestId": "string"
}

ImportSnapshotRequest

Property	Type	Description
description	string	The description for the snapshot you want to create in your account.
snapshotLocation	string	The pre-signed URL of the snapshot you want to import. For more information, see Creating a Pre-signed URL.
snapshotSize	string	The size of the snapshot you want to create in your account, in bytes. This size must be greater than or equal to the size of the original, uncompressed snapshot.

{
  "description": "string",
  "snapshotLocation": "string",
  "snapshotSize": "string"
}

ImportSnapshotResponse

Property	Type	Description
description	string	The description of the snapshot created in your account.
encrypted	boolean	Indicates whether the snapshot is encrypted or not (always false).
ownerAlias	string	The alias of the owner of the snapshot created in your account.
ownerId	string	The ID of the owner of the snapshot created in your account.
progress	string	The percentage of the task completed.
requestId	string	The ID of the request.
snapshotId	string	The ID of the snapshot created in your account.
startTime	string	The date and time at which the import task started.
status	string	The state of the snapshot created in your account (`error` \| `completed`).
volumeId	string	The ID of the volume.
volumeSize	integer	The size of the volume, in gibibytes (GiB).

{
  "description": "string",
  "encrypted": true,
  "ownerAlias": "string",
  "ownerId": "string",
  "progress": "string",
  "requestId": "string",
  "snapshotId": "string",
  "startTime": "string",
  "status": "string",
  "volumeId": "string",
  "volumeSize": 0
}

InstanceInitiatedShutdownBehavior_0

The instance behavior when you stop it. By default or if set to stop, the instance stops. If set to restart, the instance stops then automatically restarts. If set to terminate, the instance stops and is terminated.

Property	Type	Description
Value	string	The value specified for the resource attribute.

{
  "Value": "string"
}

InstanceInitiatedShutdownBehavior_1

Indicates whether the instance stops, terminates or restarts when you stop or terminate it.

Property	Type	Description
value	string	The value specified for the resource attribute.

{
  "value": "string"
}

InstanceType_0

The type of instance. For more information, see VM-Types.html">VM Types.

Property	Type	Description
Value	string	The value specified for the resource attribute.

{
  "Value": "string"
}

InstanceType_1

The type of instance. For more information, see VM-Types.html">VM Types.

Property	Type	Description
value	string	The value specified for the resource attribute.

{
  "value": "string"
}

internetGateway

Information about the newly created internet gateway.

Property	Type	Description
internetGatewayId	string	The ID of the internet gateway.
attachmentSet	[attachmentSet_1]	One or more VPCs attached to the internet gateway.
tagSet	[Tag]	One or more tags associated with the internet gateway.

{
  "internetGatewayId": "string",
  "attachmentSet": [
    {
      "state": "string",
      "vpcId": "string"
    }
  ],
  "tagSet": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

IpPermissions_0

Information about one or more IP permissions.

Property	Type	Description
FromPort	integer	The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
Groups	[Groups_0]	One or more security groups and account ID pairs.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
IpRanges	[IpRanges_0]	One or more IP ranges.
PrefixListIds	[PrefixListIds_0]	One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
ToPort	integer	The end of the port range for TCP and UDP protocols, or an ICMP code number.

{
  "FromPort": 0,
  "Groups": [
    {
      "GroupId": "string",
      "GroupName": "string",
      "UserId": "string"
    }
  ],
  "IpProtocol": "string",
  "IpRanges": [
    {
      "CidrIp": "string"
    }
  ],
  "PrefixListIds": [
    {
      "PrefixListId": "string"
    }
  ],
  "ToPort": 0
}

IpPermissions_1

The inbound rules associated with the security group.

Property	Type	Description
fromPort	integer	The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
groups	[groups_2]	One or more security groups and account ID pairs.
ipProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
ipRanges	[ipRanges_1]	One or more IP ranges.
prefixListIds	[PrefixListIds_1]	One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
toPort	integer	The end of the port range for TCP and UDP protocols, or an ICMP code number.

{
  "fromPort": 0,
  "groups": [
    {
      "groupId": "string",
      "groupName": "string",
      "userId": "string"
    }
  ],
  "ipProtocol": "string",
  "ipRanges": [
    {
      "cidrIp": "string"
    }
  ],
  "prefixListIds": [
    {
      "prefixListId": "string"
    }
  ],
  "toPort": 0
}

IpRanges_0

One or more IP ranges.

Property	Type	Description
CidrIp	string	The range of IPs.

{
  "CidrIp": "string"
}

ipRanges_1

One or more IP ranges.

Property	Type	Description
cidrIp	string	The range of IPs.

{
  "cidrIp": "string"
}

LaunchPermission_0

Permissions to access the OMI. If you specify both Add and Remove attributes in the request, only Add is taken into account.

Property	Type	Description
Add	[Add]	The account ID you want to add to the list of launch permissions for the OMI.
Remove	[Remove]	The account ID you want to remove from the list of launch permissions for the OMI.

{
  "Add": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ],
  "Remove": [
    {
      "Group": "string",
      "UserId": "string"
    }
  ]
}

MapPublicIpOnLaunch

If set to true, an External IP (EIP) is automatically assigned to the instance launched with this subnet. The EIP remains assigned to the instance, even when it is stopped, and is released when the instance is terminated.

Property	Type	Description
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "Value": true
}

ModifyImageAttributeRequest

Property	Type	Description
Description	Description_0	A new description of the resource.
ImageId	string	The ID of the OMI.
LaunchPermission	LaunchPermission_0	Permissions to access the OMI. If you specify both `Add` and `Remove` attributes in the request, only `Add` is taken into account.
ProductCode	[string]	One or more product codes to add to the OMI. Once a product code is applied to an OMI, it cannot be removed.

{
  "Description": {
    "Value": "string"
  },
  "ImageId": "string",
  "LaunchPermission": {
    "Add": [
      {
        "Group": "string",
        "UserId": "string"
      }
    ],
    "Remove": [
      {
        "Group": "string",
        "UserId": "string"
      }
    ]
  },
  "ProductCode": [
    "string"
  ]
}

ModifyImageAttributeResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

ModifyInstanceAttributeRequest

Property	Type	Description
BlockDeviceMapping	[BlockDeviceMapping_0]	The block device mapping of the instance. This parameter modifies the `DeleteOnTermination` attribute for volumes attached to the instance.
DisableApiTermination	DisableApiTermination_0	If true, you cannot terminate the instance unless you change this parameter back to false.
EbsOptimized	EbsOptimized_0	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
GroupId	[string]	A list of security groups IDs associated with the instance.
InstanceId	string	The ID of the instance.
InstanceInitiatedShutdownBehavior	InstanceInitiatedShutdownBehavior_0	The instance behavior when you stop it. By default or if set to `stop`, the instance stops. If set to `restart`, the instance stops then automatically restarts. If set to `terminate`, the instance stops and is terminated.
InstanceType	InstanceType_0	The type of instance. For more information, see VM-Types.html">VM Types.
SourceDestCheck	SourceDestCheck_0	(VPC only) If true, the source/destination check is enabled. If false, it is disabled.
UserData	UserData_0	The Base64-encoded MIME user data, limited to 500 kibibytes (KiB).

{
  "BlockDeviceMapping": [
    {
      "DeviceName": "string",
      "Ebs": {
        "DeleteOnTermination": true,
        "VolumeId": "string"
      },
      "NoDevice": "string",
      "VirtualName": "string"
    }
  ],
  "DisableApiTermination": {
    "Value": true
  },
  "EbsOptimized": {
    "Value": true
  },
  "GroupId": [
    "string"
  ],
  "InstanceId": "string",
  "InstanceInitiatedShutdownBehavior": {
    "Value": "string"
  },
  "InstanceType": {
    "Value": "string"
  },
  "SourceDestCheck": {
    "Value": true
  },
  "UserData": {
    "Value": "string"
  }
}

ModifyInstanceAttributeResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

ModifyInstanceKeypairRequest

Property	Type	Description
InstanceId	string	The ID of the instance.
KeyName	string	The name of the keypair.

{
  "InstanceId": "string",
  "KeyName": "string"
}

ModifyInstanceKeypairResponse

Property	Type	Description
requestId	string	The ID of the request.

{
  "requestId": "string"
}

ModifyNetworkInterfaceAttributeRequest

Property	Type	Description
Attachment	Attachment	A new configuration for the attachment.
Description	Description_0	A new description of the resource.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
NetworkInterfaceId	string	The ID of the FNI.
SecurityGroupId	[string]	One or more IDs of security groups to associate with the FNI. The FNI must be associated with at least one security group.

{
  "Attachment": {
    "AttachmentId": "string",
    "DeleteOnTermination": true
  },
  "Description": {
    "Value": "string"
  },
  "DryRun": true,
  "NetworkInterfaceId": "string",
  "SecurityGroupId": [
    "string"
  ]
}

ModifyNetworkInterfaceAttributeResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

ModifySnapshotAttributeRequest

Property	Type	Description
CreateVolumePermission	CreateVolumePermission_0	Enables you to modify the permissions to create a volume for account IDs or groups. If you specify both `Add` and `Remove` attributes in the request, only `Add` is taken into account.
DryRun	boolean	If set to true, checks whether you have the required permissions to perform the action.
SnapshotId	string	The ID of the snapshot.

{
  "CreateVolumePermission": {
    "Add": [
      {
        "Group": "string",
        "UserId": "string"
      }
    ],
    "Remove": [
      {
        "Group": "string",
        "UserId": "string"
      }
    ]
  },
  "DryRun": true,
  "SnapshotId": "string"
}

ModifySnapshotAttributeResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

ModifySubnetAttributeRequest

Property	Type	Description
MapPublicIpOnLaunch	MapPublicIpOnLaunch	If set to true, an External IP (EIP) is automatically assigned to the instance launched with this subnet. The EIP remains assigned to the instance, even when it is stopped, and is released when the instance is terminated.
SubnetId	string	The ID of the subnet.

{
  "MapPublicIpOnLaunch": {
    "Value": true
  },
  "SubnetId": "string"
}

ModifySubnetAttributeResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

ModifyVpcEndpointRequest

Property	Type	Description
AddRouteTableId	[string]	One or more IDs of route tables to associate with the specified VPC endpoint.
RemoveRouteTableId	[string]	One or more IDs of route tables to disassociate from the specified VPC endpoint.
VpcEndpointId	string	The ID of the VPC endpoint.

{
  "AddRouteTableId": [
    "string"
  ],
  "RemoveRouteTableId": [
    "string"
  ],
  "VpcEndpointId": "string"
}

ModifyVpcEndpointResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

NetworkInterface_0

One or more network interfaces. If you specify this parameter, you must define one network interface as the primary one of the instance with 0 as its device index.

Property	Type	Description
DeleteOnTermination	boolean	By default or if set to true, the network interface is deleted when the instance is terminated. You can specify this parameter only for a new network interface. To modify this value for an existing network interface, see ModifyNetworkInterfaceAttribute.
Description	string	The description of the network interface, if you are creating a network interface when launching an instance.
DeviceIndex	integer	The index of the instance device for the network interface attachment (between `0` and `7`, both included). This parameter is required if you create a network interface when launching an instance.
NetworkInterfaceId	string	The ID of the network interface, if you are attaching an existing network interface when launching an instance.
PrivateIpAddress	string	The private IP of the network interface, if you are creating a network interface when launching an instance.
PrivateIpAddressesSet	[PrivateIpAddressesSet]	One or more private IPs to assign to the network interface (only one can be primary), if you are creating a network interface when launching an instance.
SecondaryPrivateIpAddressCount	integer	The number of secondary private IPs (cannot be specified if you specified more than one private IP in the PrivateIPAddressesSet.N parameter), if you are creating a network interface when launching an instance.
SecurityGroupId	[string]	One or more IDs of the security groups of the network interface, if you are creating a network interface when launching an instance.
SubnetId	string	The ID of the subnet associated with the network string, if you are creating a network interface when launching an instance.

{
  "DeleteOnTermination": true,
  "Description": "string",
  "DeviceIndex": 0,
  "NetworkInterfaceId": "string",
  "PrivateIpAddress": "string",
  "PrivateIpAddressesSet": [
    {
      "Primary": true,
      "PrivateIpAddress": "string"
    }
  ],
  "SecondaryPrivateIpAddressCount": 0,
  "SecurityGroupId": [
    "string"
  ],
  "SubnetId": "string"
}

NetworkInterface_1

Information about the newly created FNI.

Property	Type	Description
association	association_0	Information about the association between the FNI and an EIP.
attachment	attachment_1	Information about the FNI attachment.
availabilityZone	string	The AZ where the FNI is located.
description	string	The description of the FNI.
groupSet	[groupSet]	One or more security groups for the instance.
macAddress	string	The Media Access Control (MAC) address of the FNI.
networkInterfaceId	string	The ID of the FNI.
ownerId	string	The account ID of the FNI owner.
privateDnsName	string	The private DNS name associated with the primary private IP of the FNI.
privateIpAddress	string	The primary private IP of the FNI.
privateIpAddressesSet	[privateIpAddressesSet_0]	Information about the EIP and the private IPs assigned to the FNI.
sourceDestCheck	boolean	If true, the traffic to or from the instance is validated. If false, it is not.
status	string	The state of the FNI.
subnetId	string	The ID of the subnet where the FNI is located.
tagSet	[tagSet_0]	One or more tags associated with the FNI.
vpcId	string	The ID of the VPC where the FNI is located.

{
  "association": {
    "allocationId": "string",
    "associationId": "string",
    "ipOwnerId": "string",
    "publicDnsName": "string",
    "publicIp": "string"
  },
  "attachment": {
    "attachTime": "string",
    "attachmentId": "string",
    "deleteOnTermination": true,
    "deviceIndex": 0,
    "instanceId": "string",
    "instanceOwnerId": "string",
    "status": "string"
  },
  "availabilityZone": "string",
  "description": "string",
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "macAddress": "string",
  "networkInterfaceId": "string",
  "ownerId": "string",
  "privateDnsName": "string",
  "privateIpAddress": "string",
  "privateIpAddressesSet": [
    {
      "association": {
        "allocationId": "string",
        "associationId": "string",
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "primary": true,
      "privateDnsName": "string",
      "privateIpAddress": "string"
    }
  ],
  "sourceDestCheck": true,
  "status": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

Options_0

Options for a VPN connection.

Property	Type	Description
StaticRoutesOnly	boolean	By default or if false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.

{
  "StaticRoutesOnly": true
}

Options_1

Options for a VPN connection.

Property	Type	Description
staticRoutesOnly	boolean	If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.

{
  "staticRoutesOnly": true
}

OsuAkSk

The access key and secret key of the OOS account used to access the bucket.

Property	Type	Description
AccessKey	string	The access key of the OOS account that enables you to access the bucket.
SecretKey	string	The secret key of the OOS account that enables you to access the bucket.

{
  "AccessKey": "string",
  "SecretKey": "string"
}

Placement_0

A specific placement where you want to create the instances (tenancy options).

Property	Type	Description
AvailabilityZone	string	The Availability Zone of the instance.
Tenancy	string	The tenancy of the instance (`default` \| `dedicated`).

{
  "AvailabilityZone": "string",
  "Tenancy": "string"
}

Placement_1

A specific placement where you want to create the instances.

Property	Type	Description
availabilityZone	string	The Availability Zone of the instance.
groupName	string	The name of the placement group of the instance (always `null`).
tenancy	string	The tenancy of the instance (`default` \| `dedicated`).

{
  "availabilityZone": "string",
  "groupName": "string",
  "tenancy": "string"
}

PrefixListIds_0

One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.

Property	Type	Description
PrefixListId	string	The ID of the prefix.

{
  "PrefixListId": "string"
}

PrefixListIds_1

One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.

Property	Type	Description
prefixListId	string	The ID of the prefix.

{
  "prefixListId": "string"
}

PrivateIpAddressesSet

One or more private IPs to assign to the network interface (only one can be primary), if you are creating a network interface when launching an instance.

Property	Type	Description
Primary	boolean	Indicates whether it is the primary private IP.
PrivateIpAddress	string	The private IPs.

{
  "Primary": true,
  "PrivateIpAddress": "string"
}

QuotaSet

One or more quotas associated with the account.

Property	Type	Description
description	string	The description of the quota.
displayName	string	The display name of the quota.
groupName	string	The group name the quota belongs to.
maxQuotaValue	integer	The maximum value of the quota for the account (if there is no limit, `0`).
name	string	The unique name of the quota.
ownerId	string	The account ID of owner of the quota.
usedQuotaValue	integer	The limit value currently used by the account.

{
  "description": "string",
  "displayName": "string",
  "groupName": "string",
  "maxQuotaValue": 0,
  "name": "string",
  "ownerId": "string",
  "usedQuotaValue": 0
}

ReadPublicIpRangesRequest

ReadPublicIpRangesResponse

Property	Type	Description
publicIpSet	[string]	The list of public IPv4 addresses used in the Region, in CIDR notation.
requestId	string	The ID of the request.

{
  "publicIpSet": [
    "string"
  ],
  "requestId": "string"
}

RebootInstancesRequest

Property	Type	Description
InstanceId	[string]	The IDs of the instances you want to reboot.

{
  "InstanceId": [
    "string"
  ]
}

RebootInstancesResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

RegisterImageRequest

Property	Type	Description
Architecture	string	The architecture of the OMI (set to `i386` by default).
BlockDeviceMapping	[BlockDeviceMapping_1]	One or more Block Device Mapping entries.
Description	string	A description for the OMI.
ImageLocation	string	The pre-signed URL of the OMI manifest file, or the full path to the OMI stored in a bucket. If you specify this parameter, a copy of the OMI is created in your account.
Name	string	A unique name for the OMI.
RootDeviceName	string	The name of the root device. This value must be `/dev/sda1`.

{
  "Architecture": "string",
  "BlockDeviceMapping": [
    {
      "DeviceName": "string",
      "Ebs": {
        "DeleteOnTermination": true,
        "Iops": 0,
        "SnapshotId": "string",
        "VolumeSize": 0,
        "VolumeType": "string"
      },
      "NoDevice": "string",
      "VirtualName": "string"
    }
  ],
  "Description": "string",
  "ImageLocation": "string",
  "Name": "string",
  "RootDeviceName": "string"
}

RegisterImageResponse

Property	Type	Description
imageId	string	The ID of the newly registered OMI.
requestId	string	The ID of the request.

{
  "imageId": "string",
  "requestId": "string"
}

RejectVpcPeeringConnectionRequest

Property	Type	Description
VpcPeeringConnectionId	string	The ID of the VPC peering connection you want to reject.

{
  "VpcPeeringConnectionId": "string"
}

RejectVpcPeeringConnectionResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

ReleaseAddressRequest

Property	Type	Description
AllocationId	string	The allocation ID of the EIP in your account (required in a VPC).
PublicIp	string	The EIP (required in the public Cloud).

{
  "AllocationId": "string",
  "PublicIp": "string"
}

ReleaseAddressResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

Remove

The account ID you want to remove from the list of permissions for the volume.

Property	Type	Description
Group	string	The name of the group (`all` if public).
UserId	string	The ID of the account.

{
  "Group": "string",
  "UserId": "string"
}

ReplaceRouteRequest

Property	Type	Description
DestinationCidrBlock	string	The CIDR block used for the destination match.
GatewayId	string	The ID of an internet gateway or virtual private gateway attached to your VPC.
InstanceId	string	The ID of a NAT instance in your VPC.
NatGatewayId	string	The ID of a NAT gateway.
NetworkInterfaceId	string	The ID of a network interface.
RouteTableId	string	The ID of the route table.
VpcPeeringConnectionId	string	The ID of a VPC peering connection.

{
  "DestinationCidrBlock": "string",
  "GatewayId": "string",
  "InstanceId": "string",
  "NatGatewayId": "string",
  "NetworkInterfaceId": "string",
  "RouteTableId": "string",
  "VpcPeeringConnectionId": "string"
}

ReplaceRouteResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

ReplaceRouteTableAssociationRequest

Property	Type	Description
AssociationId	string	The ID of the current route table association.
RouteTableId	string	The ID of the new route table to associate with the subnet.

{
  "AssociationId": "string",
  "RouteTableId": "string"
}

ReplaceRouteTableAssociationResponse

Property	Type	Description
newAssociationId	string	The ID of the new route table association.
requestId	string	The ID of the request.

{
  "newAssociationId": "string",
  "requestId": "string"
}

RevokeSecurityGroupEgressRequest

Property	Type	Description
CidrIp	string	The CIDR IP range.
FromPort	integer	The beginning of port range for the TCP and UDP protocols, or an ICMP type number.
GroupId	string	The ID of the security group.
IpPermissions	[IpPermissions_0]	Information about one or more IP permissions.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName	string	The name of a destination security group.
SourceSecurityGroupOwnerId	string	The OUTSCALE account ID of the owner of a destination security group.
ToPort	integer	The end of port range for the TCP and UDP protocols, or an ICMP code number.

{
  "CidrIp": "string",
  "FromPort": 0,
  "GroupId": "string",
  "IpPermissions": [
    {
      "FromPort": 0,
      "Groups": [
        {
          "GroupId": "string",
          "GroupName": "string",
          "UserId": "string"
        }
      ],
      "IpProtocol": "string",
      "IpRanges": [
        {
          "CidrIp": "string"
        }
      ],
      "PrefixListIds": [
        {
          "PrefixListId": "string"
        }
      ],
      "ToPort": 0
    }
  ],
  "IpProtocol": "string",
  "SourceSecurityGroupName": "string",
  "SourceSecurityGroupOwnerId": "string",
  "ToPort": 0
}

RevokeSecurityGroupEgressResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

RevokeSecurityGroupIngressRequest

Property	Type	Description
CidrIp	string	The CIDR IP range.
FromPort	integer	The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
GroupId	string	The ID of the security group.
GroupName	string	The name of the security group, if you are in the public Cloud.
IpPermissions	[IpPermissions_0]	A set of IP permissions.
IpProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
SourceSecurityGroupName	string	The name of the source security group (cannot be specified alongside the CIDR IP range, the start of the port range, the IP protocol, and the end of the port range).
SourceSecurityGroupOwnerId	string	The account ID of the owner of the source security group.
ToPort	integer	The end of the port range for the TCP and UDP protocols, or an ICMP code number.

{
  "CidrIp": "string",
  "FromPort": 0,
  "GroupId": "string",
  "GroupName": "string",
  "IpPermissions": [
    {
      "FromPort": 0,
      "Groups": [
        {
          "GroupId": "string",
          "GroupName": "string",
          "UserId": "string"
        }
      ],
      "IpProtocol": "string",
      "IpRanges": [
        {
          "CidrIp": "string"
        }
      ],
      "PrefixListIds": [
        {
          "PrefixListId": "string"
        }
      ],
      "ToPort": 0
    }
  ],
  "IpProtocol": "string",
  "SourceSecurityGroupName": "string",
  "SourceSecurityGroupOwnerId": "string",
  "ToPort": 0
}

RevokeSecurityGroupIngressResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

RunInstancesRequest

Property	Type	Description
BlockDeviceMapping	[BlockDeviceMapping_1]	One or more block device mappings of the instance.
ClientToken	string	A unique identifier which enables you to manage the idempotency.
DisableApiTermination	boolean	If true, you cannot terminate the instance unless you change this parameter back to false.
DryRun	boolean	If true, checks whether you have the required permissions to perform the action.
EbsOptimized	boolean	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
ImageId	string	The ID of the OMI. You can find the list of OMIs by calling the DescribeImages method.
InstanceInitiatedShutdownBehavior	string	The instance behavior when you stop it. By default or if set to `stop`, the instance stops. If set to `restart`, the instance stops then automatically restarts. If set to `terminate`, the instance stops and is terminated.
InstanceType	string	The type of instance. You can specify a TINA type (in the `tinavW.cXrYpZ` or `tinavW.cXrY` format), or an AWS type (for example, `t2.small`, which is the default value). If you specify an AWS type, it is converted in the background to its corresponding TINA type, but the AWS type is still returned. The TINA type is associated with a performance flag. For more information, see VM-Types.html">VM Types.
KeyName	string	The name of the keypair.
MaxCount	integer	The maximum number of instances you want to launch. If all the instances cannot be created, the largest possible number of instances above MinCount are created and launched.
MinCount	integer	The minimum number of instances you want to launch. If this number of instances cannot be created, FCU does not create and launch any instance.
NetworkInterface	[NetworkInterface_0]	One or more network interfaces. If you specify this parameter, you must define one network interface as the primary one of the instance with 0 as its device index.
Placement	Placement_0	A specific placement where you want to create the instances (tenancy options).
PrivateIpAddress	string	In a VPC, the unique primary IP. The IP must come from the IP range of the subnet.
PrivateIpAddresses	string	In a VPC, the list of primary IPs when you create several instances. The IPs must come from the IP range of the subnet.
SecurityGroup	[string]	One or more security group names.
SecurityGroupId	[string]	One or more security group IDs.
SubnetId	string	In a VPC, the ID of the subnet in which you want to launch the instance.
UserData	string	Data or script used to add a specific configuration to the instance. It must be Base64-encoded and is limited to 500 kibibytes (KiB).

{
  "BlockDeviceMapping": [
    {
      "DeviceName": "string",
      "Ebs": {
        "DeleteOnTermination": true,
        "Iops": 0,
        "SnapshotId": "string",
        "VolumeSize": 0,
        "VolumeType": "string"
      },
      "NoDevice": "string",
      "VirtualName": "string"
    }
  ],
  "ClientToken": "string",
  "DisableApiTermination": true,
  "DryRun": true,
  "EbsOptimized": true,
  "ImageId": "string",
  "InstanceInitiatedShutdownBehavior": "string",
  "InstanceType": "string",
  "KeyName": "string",
  "MaxCount": 0,
  "MinCount": 0,
  "NetworkInterface": [
    {
      "DeleteOnTermination": true,
      "Description": "string",
      "DeviceIndex": 0,
      "NetworkInterfaceId": "string",
      "PrivateIpAddress": "string",
      "PrivateIpAddressesSet": [
        {
          "Primary": true,
          "PrivateIpAddress": "string"
        }
      ],
      "SecondaryPrivateIpAddressCount": 0,
      "SecurityGroupId": [
        "string"
      ],
      "SubnetId": "string"
    }
  ],
  "Placement": {
    "AvailabilityZone": "string",
    "Tenancy": "string"
  },
  "PrivateIpAddress": "string",
  "PrivateIpAddresses": "string",
  "SecurityGroup": [
    "string"
  ],
  "SecurityGroupId": [
    "string"
  ],
  "SubnetId": "string",
  "UserData": "string"
}

RunInstancesResponse

Property	Type	Description
groupSet	[groupSet]	One or more security groups.
instancesSet	[instancesSet_0]	One or more instances.
ownerId	string	The ID of the account which has reserved the instances.
requestId	string	The ID of the request.
requesterId	string	The ID of the requester.
reservationId	string	Zero or more reservations, giving you information about your request.

{
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "instancesSet": [
    {
      "amiLaunchIndex": 0,
      "architecture": "string",
      "blockDeviceMapping": [
        {
          "deviceName": "string",
          "ebs": {
            "attachTime": "string",
            "deleteOnTermination": true,
            "status": "string",
            "volumeId": "string"
          }
        }
      ],
      "clientToken": "string",
      "dnsName": "string",
      "ebsOptimized": true,
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "hypervisor": "string",
      "iamInstanceProfile": {
        "arn": "string",
        "id": "string"
      },
      "imageId": "string",
      "instanceId": "string",
      "instanceLifecycle": "string",
      "instanceState": {
        "code": 0,
        "name": "string"
      },
      "instanceType": "string",
      "ipAddress": "string",
      "kernelId": "string",
      "keyName": "string",
      "launchTime": "string",
      "monitoring": {
        "state": "string"
      },
      "networkInterfaceSet": [
        {
          "association": {
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "attachment": {
            "attachTime": "string",
            "attachmentId": "string",
            "deleteOnTermination": true,
            "deviceIndex": 0,
            "status": "string"
          },
          "description": "string",
          "groupSet": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "macAddress": "string",
          "networkInterfaceId": "string",
          "ownerId": "string",
          "privateDnsName": "string",
          "privateIpAddress": "string",
          "privateIpAddressesSet": [
            {
              "association": {
                "ipOwnerId": "string",
                "publicDnsName": "string",
                "publicIp": "string"
              },
              "primary": true,
              "privateDnsName": "string",
              "privateIpAddress": "string"
            }
          ],
          "sourceDestCheck": true,
          "status": "string",
          "subnetId": "string",
          "vpcId": "string"
        }
      ],
      "placement": {
        "availabilityZone": "string",
        "groupName": "string",
        "tenancy": "string"
      },
      "platform": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "productCodes": [
        {
          "productCode": "string",
          "type": "string"
        }
      ],
      "ramdiskId": "string",
      "reason": "string",
      "rootDeviceName": "string",
      "rootDeviceType": "string",
      "sourceDestCheck": true,
      "spotInstanceRequestId": "string",
      "sriovNetSupport": "string",
      "stateReason": {
        "code": "string",
        "message": "string"
      },
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "virtualizationType": "string",
      "vpcId": "string"
    }
  ],
  "ownerId": "string",
  "requestId": "string",
  "requesterId": "string",
  "reservationId": "string"
}

SourceDestCheck_0

(VPC only) If true, the source/destination check is enabled. If false, it is disabled.

Property	Type	Description
Value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "Value": true
}

SourceDestCheck_1

(VPC only) If true, the source/destination check is enabled. If false, it is disabled.

Property	Type	Description
value	boolean	A boolean value (true or false) that can be used when the resource is of boolean type.

{
  "value": true
}

StartInstancesRequest

Property	Type	Description
InstanceId	[string]	One or more instance IDs.

{
  "InstanceId": [
    "string"
  ]
}

StartInstancesResponse

Property	Type	Description
instancesSet	[instancesSet_1]	Information about the started instances.
requestId	string	The ID of the request.

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

StopInstancesRequest

Property	Type	Description
Force	boolean	Forces the instance to stop.
InstanceId	[string]	One or more instance IDs.

{
  "Force": true,
  "InstanceId": [
    "string"
  ]
}

StopInstancesResponse

Property	Type	Description
instancesSet	[instancesSet_1]	Information about one or more stopped instances.
requestId	string	The ID of the request.

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

Tag

One or more tags you want to add to the specified resources. Example for an instance:
osc-cli fcu CreateTags \
  --ResourceId i-xxxxxxxx \
  --Tag.1.Key "AAAA" --Tag.1.Value "BBBB" \
  --Tag.2.Key "CCCC" --Tag.2.Value "DDDD"

Property	Type	Description
Key	string	The key of the tag, with a minimum of 1 character.
Value	string	The value of the tag, between 0 and 255 characters.

{
  "Key": "string",
  "Value": "string"
}

tagSet

One or more tags associated with the OMI export task.

Property	Type	Description
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.

{
  "key": "string",
  "value": "string"
}

TerminateInstancesRequest

Property	Type	Description
InstanceId	[string]	One or more instance IDs.

{
  "InstanceId": [
    "string"
  ]
}

TerminateInstancesResponse

Property	Type	Description
instancesSet	[instancesSet_1]	Information about one or more terminated instances.
requestId	string	The ID of the request.

{
  "instancesSet": [
    {
      "currentState": {
        "code": 0,
        "name": "string"
      },
      "instanceId": "string",
      "previousState": {
        "code": 0,
        "name": "string"
      }
    }
  ],
  "requestId": "string"
}

UnassignPrivateIpAddressesRequest

Property	Type	Description
NetworkInterfaceId	string	The ID of the FNI.
PrivateIpAddress	[string]	One or more secondary private IPs you want to unassign from the FNI.

{
  "NetworkInterfaceId": "string",
  "PrivateIpAddress": [
    "string"
  ]
}

UnassignPrivateIpAddressesResponse

Property	Type	Description
requestId	string	The ID of the request.
return	boolean	Always true when the request succeeds.

{
  "requestId": "string",
  "return": true
}

UserData_0

The Base64-encoded MIME user data, limited to 500 kibibytes (KiB).

Property	Type	Description
Value	string	The value to use for the resource attribute.

{
  "Value": "string"
}

UserData_1

The Base64-encoded MIME user data.

Property	Type	Description
value	string	The value specified for the resource attribute.

{
  "value": "string"
}

accepterVpcInfo

Information about the peer VPC of the VPC peering connection.

Property	Type	Description
cidrBlock	string	The CIDR block of the VPC.
ownerId	string	The account ID of the owner of the VPC.
vpcId	string	The ID of the VPC.

{
  "cidrBlock": "string",
  "ownerId": "string",
  "vpcId": "string"
}

addressesSet

Information about one or more External IPs.

Property	Type	Description
allocationId	string	The ID of the address allocation for use with a VPC.
associationId	string	The ID of the address association with an instance in a VPC.
domain	string	Indicates whether the External IP is for use with instances in the public Cloud or in a VPC.
instanceId	string	The ID of the instance the address is associated with.
networkInterfaceId	string	The ID of the network interface.
networkInterfaceOwnerId	string	The account ID of the owner of the network interface.
privateIpAddress	string	The private IP associated with the External IP.
publicIp	string	The External IP.

{
  "allocationId": "string",
  "associationId": "string",
  "domain": "string",
  "instanceId": "string",
  "networkInterfaceId": "string",
  "networkInterfaceOwnerId": "string",
  "privateIpAddress": "string",
  "publicIp": "string"
}

aksk

The access key and secret key of the OOS account used to access the bucket.

Property	Type	Description
AccessKey	string	The access key of the OOS account that enables you to access the bucket.
SecretKey	string	The secret key of the OOS account that enables you to access the bucket.

{
  "AccessKey": "string",
  "SecretKey": "string"
}

associationSet

One or more associations between the route table and the subnets.

Property	Type	Description
main	boolean	If true, the route table is the main one.
routeTableAssociationId	string	The ID of the association between a route table and a subnet.
routeTableId	string	The ID of the route table.
subnetId	string	The ID of the subnet.

{
  "main": true,
  "routeTableAssociationId": "string",
  "routeTableId": "string",
  "subnetId": "string"
}

association_0

Information about the association between the FNI and an EIP.

Property	Type	Description
allocationId	string	The allocation ID returned when you allocated the EIP to your account.
associationId	string	The association ID returned when the FNI was associated with an EIP.
ipOwnerId	string	The account ID of the owner of the EIP associated with the FNI.
publicDnsName	string	The public DNS name associated with the EIP.
publicIp	string	The EIP associated with the FNI.

{
  "allocationId": "string",
  "associationId": "string",
  "ipOwnerId": "string",
  "publicDnsName": "string",
  "publicIp": "string"
}

association_1

Information about an External IP associated with the interface.

Property	Type	Description
ipOwnerId	string	The account ID of the owner of the External IP.
publicDnsName	string	The name of the public DNS.
publicIp	string	The External IP (EIP) associated with the network interface.

{
  "ipOwnerId": "string",
  "publicDnsName": "string",
  "publicIp": "string"
}

attachmentSet_0

Information about the attachment.

Property	Type	Description
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
device	string	The name of the device.
instanceId	string	The ID of the instance.
status	string	The attachment state of the volume (`attaching` \| `detaching` \| `attached` \| `detached`).
volumeId	string	The ID of the volume.

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "device": "string",
  "instanceId": "string",
  "status": "string",
  "volumeId": "string"
}

attachmentSet_1

One or more VPCs attached to the internet gateway.

Property	Type	Description
state	string	The state of the attachment (always `available`).
vpcId	string	The ID of the VPC.

{
  "state": "string",
  "vpcId": "string"
}

attachment_0

Information about the attachment.

Property	Type	Description
state	string	The current state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`).
vpcId	string	The ID of the Virtual Private Cloud (VPC).

{
  "state": "string",
  "vpcId": "string"
}

attachment_1

Information about the FNI attachment.

Property	Type	Description
attachTime	string	The time at which the FNI was attached to an instance.
attachmentId	string	The attachment ID of the FNI.
deleteOnTermination	boolean	If true, the FNI is deleted when terminating the instance. If false, it is only detached.
deviceIndex	integer	The device index used for the FNI attachment.
instanceId	string	The ID of the instance the FNI is attached to.
instanceOwnerId	string	The account ID of the owner of the instance the FNI is attached to.
status	string	The state of the attachment.

{
  "attachTime": "string",
  "attachmentId": "string",
  "deleteOnTermination": true,
  "deviceIndex": 0,
  "instanceId": "string",
  "instanceOwnerId": "string",
  "status": "string"
}

attachment_2

The attachment of the network interface.

Property	Type	Description
attachTime	string	The time at which the attachment was initiated.
attachmentId	string	The ID of the network interface attachment.
deleteOnTermination	boolean	If true, the network interface is deleted when the instance is terminated.
deviceIndex	integer	The index of the instance device for the attachment.
status	string	The state of the network interface (`attaching` \| `attached` \| `detaching` \| `detached`).

{
  "attachTime": "string",
  "attachmentId": "string",
  "deleteOnTermination": true,
  "deviceIndex": 0,
  "status": "string"
}

availabilityZoneInfo

Information about the Availability Zones.

Property	Type	Description
regionName	string	The name of the Region containing the Availability Zone.
zoneName	string	The name of the Availability Zone.
zoneState	string	The state of the Availability Zone.

{
  "regionName": "string",
  "zoneName": "string",
  "zoneState": "string"
}

currentState

The current state of the instance.

Property	Type	Description
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).

{
  "code": 0,
  "name": "string"
}

customerGateway

Information about the newly created customer gateway.

Property	Type	Description
bgpAsn	integer (int64)	The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the internet.
customerGatewayId	string	The ID of the customer gateway.
ipAddress	string	The public IPv4 address of the customer gateway (must be a fixed address into a NATed network).
state	string	The state of the customer gateway (`pending` \| `available` \| `deleting` \| `deleted`).
tagSet	[tagSet_0]	One or more tags associated with the customer gateway.
type	string	The type of communication tunnel used by the customer gateway (always `ipsec.1`).

{
  "bgpAsn": 0,
  "customerGatewayId": "string",
  "ipAddress": "string",
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "type": "string"
}

customerGatewaySet

Information about one or more customer gateways.

Property	Type	Description
bgpAsn	integer (int64)	The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the internet.
customerGatewayId	string	The ID of the customer gateway.
ipAddress	string	The public IPv4 address of the customer gateway (must be a fixed address into a NATed network).
state	string	The state of the customer gateway (`pending` \| `available` \| `deleting` \| `deleted`).
tagSet	[tagSet_0]	One or more tags associated with the customer gateway.
type	string	The type of communication tunnel used by the customer gateway (always `ipsec.1`).

{
  "bgpAsn": 0,
  "customerGatewayId": "string",
  "ipAddress": "string",
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "type": "string"
}

dhcpConfigurationSet

One or more DHCP options in the set.

Property	Type	Description
key	string	The name of an option in the DHCP configuration.
valueSet	[valueSet]	The value for the option in the DHCP configuration.

{
  "key": "string",
  "valueSet": [
    {
      "value": "string"
    }
  ]
}

dhcpOptions

A set of DHCP options.

Property	Type	Description
dhcpConfigurationSet	[dhcpConfigurationSet]	One or more DHCP options in the set.
dhcpOptionsId	string	The ID of the DHCP options set.
tagSet	[tagSet_0]	One or more tags associated with the DHCP options set.

{
  "dhcpConfigurationSet": [
    {
      "key": "string",
      "valueSet": [
        {
          "value": "string"
        }
      ]
    }
  ],
  "dhcpOptionsId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

dhcpOptionsSet

Information about one or more DHCP options sets.

Property	Type	Description
dhcpConfigurationSet	[dhcpConfigurationSet]	One or more DHCP options in the set.
dhcpOptionsId	string	The ID of the DHCP options set.
tagSet	[tagSet_0]	One or more tags associated with the DHCP options set.

{
  "dhcpConfigurationSet": [
    {
      "key": "string",
      "valueSet": [
        {
          "value": "string"
        }
      ]
    }
  ],
  "dhcpOptionsId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

ebs

One or more parameters used to automatically set up volumes when the instance is launched.

Property	Type	Description
attachTime	string	The time at which the attachment was initiated.
deleteOnTermination	boolean	If true, the volume is deleted when terminating the instance. If false, the volume is not deleted when terminating the instance.
status	string	The attachment state (`attaching` \| `attached` \| `detaching` \| `detached`).
volumeId	string	The ID of the volume.

{
  "attachTime": "string",
  "deleteOnTermination": true,
  "status": "string",
  "volumeId": "string"
}

error

Information about the error.

Property	Type	Description
code	string	The error code.
message	string	The error message corresponding to the error code.

{
  "code": "string",
  "message": "string"
}

eventsSet

One or more scheduled events associated with the instance.

Property	Type	Description
code	string	The event code (`system-reboot` \| `system-maintenance`).
description	string	A description of the event.
notAfter	string	The latest scheduled end time for the event.
notBefore	string	The earliest scheduled start time for the event.

{
  "code": "string",
  "description": "string",
  "notAfter": "string",
  "notBefore": "string"
}

groupSet

One or more security groups for the instance.

Property	Type	Description
groupId	string	The ID of the security group.
groupName	string	The name of the security group.

{
  "groupId": "string",
  "groupName": "string"
}

iamInstanceProfile

The EIM instance profile associated with the instance.

Property	Type	Description
arn	string	The unique identifier of the resource (between 20 and 2048 characters).
id	string	The ID of the instance profile.

{
  "arn": "string",
  "id": "string"
}

imageExport

Information about the OMI you want to export.

Property	Type	Description
imageId	string	The ID of the OMI to be exported.

{
  "imageId": "string"
}

imageExportTask

Information about one or more image export tasks.

Property	Type	Description
exportToOsu	exportToOsu_2	Information about the OMI export task.
imageExport	imageExport	Information about the OMI you want to export.
imageExportTaskId	string	The ID of the OMI export task.
state	string	The state of the OMI export task (`pending/queued` \| `pending` \| `completed` \| `failed` \| `cancelled`).
statusMessage	string	If the OMI export task fails, an error message appears.
tagSet	[tagSet_0]	One or more tags associated with the OMI export task.

{
  "exportToOsu": {
    "diskImageFormat": "string",
    "osuAkSk": {
      "AccessKey": "string",
      "SecretKey": "string"
    },
    "osuBucket": "string",
    "osuManifestUrl": "string",
    "osuPrefix": "string"
  },
  "imageExport": {
    "imageId": "string"
  },
  "imageExportTaskId": "string",
  "state": "string",
  "statusMessage": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

imagesSet

Information about one or more OMIs.

Property	Type	Description
architecture	string	The architecture of the OMI.
blockDeviceMapping	[BlockDeviceMapping_2]	One or more block device mapping entries.
description	string	The description of the OMI, provided when it was created.
hypervisor	string	The hypervisor type of the instance (always `xen`).
imageId	string	The ID of OUTSCALE machine image (OMI).
imageLocation	string	The location of the bucket where the OMI files are stored.
imageOwnerAlias	string	The account alias of the owner of the OMI.
imageOwnerId	string	The account ID of the owner of the OMI.
imageState	string	The current state of the OMI (`pending` \| `available` \| `failed`).
imageType	string	The type of the OMI.
isPublic	boolean	If true, the OMI has public launch permissions.
name	string	The name of the OMI, provided when it was created.
platform	string	The value is `Windows` for Windows OMIs, or blank otherwise.
productCodes	[productCodes]	One or more product codes associated with the OMI.
rootDeviceName	string	The name of the device to which the root device is plugged in (for example, `/dev/sda1`).
rootDeviceType	string	The type of root device used by the OMI.
stateReason	stateReason	The reason for the OMI state change.
tagSet	[tagSet_0]	One or more tags associated with the OMI.
virtualizationType	string	The virtualization type.

{
  "architecture": "string",
  "blockDeviceMapping": [
    {
      "deviceName": "string",
      "ebs": {
        "deleteOnTermination": true,
        "iops": 0,
        "snapshotId": "string",
        "volumeSize": 0,
        "volumeType": "string"
      },
      "noDevice": "string",
      "virtualName": "string"
    }
  ],
  "description": "string",
  "hypervisor": "string",
  "imageId": "string",
  "imageLocation": "string",
  "imageOwnerAlias": "string",
  "imageOwnerId": "string",
  "imageState": "string",
  "imageType": "string",
  "isPublic": true,
  "name": "string",
  "platform": "string",
  "productCodes": [
    {
      "productCode": "string",
      "type": "string"
    }
  ],
  "rootDeviceName": "string",
  "rootDeviceType": "string",
  "stateReason": {
    "code": "string",
    "message": "string"
  },
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "virtualizationType": "string"
}

instanceState

The state of the instance.

Property	Type	Description
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).

{
  "code": 0,
  "name": "string"
}

instanceStatus

Impaired functionality that stems from issues internal to the instance (for example, impaired reachability).

Property	Type	Description
details	[details]	The system instance health or application instance health.
status	string	The state of the instance.

{
  "details": [
    {
      "impairedSince": "string",
      "name": "string",
      "status": "string"
    }
  ],
  "status": "string"
}

instanceStatusSet

One or more instance status descriptions.

Property	Type	Description
availabilityZone	string	The Availability Zone in which the instance is located.
eventsSet	[eventsSet]	One or more scheduled events associated with the instance.
instanceId	string	The ID of the instance.
instanceState	instanceState	The state of the instance.
instanceStatus	instanceStatus	Impaired functionality that stems from issues internal to the instance (for example, impaired reachability).
systemStatus	systemStatus	Impaired functionality that stems from issues related to the systems supporting an instance (for example, hardware failures or network connectivity problems).

{
  "availabilityZone": "string",
  "eventsSet": [
    {
      "code": "string",
      "description": "string",
      "notAfter": "string",
      "notBefore": "string"
    }
  ],
  "instanceId": "string",
  "instanceState": {
    "code": 0,
    "name": "string"
  },
  "instanceStatus": {
    "details": [
      {
        "impairedSince": "string",
        "name": "string",
        "status": "string"
      }
    ],
    "status": "string"
  },
  "systemStatus": {
    "details": [
      {
        "impairedSince": "string",
        "name": "string",
        "status": "string"
      }
    ],
    "status": "string"
  }
}

instanceTypeSet

Information about one or more instance types.

Property	Type	Description
ebsOptimizedAvailable	boolean	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
ephemeralsType	string	The type of ephemeral storage disk.
eth	integer	The number of Ethernet interfaces available.
gpu	integer	The number of GPUs available.
maxIpAddresses	integer	The maximum number of private IPs per network interface.
memory	integer	The amount of memory, in bytes.
name	string	The name of the instance type.
storageCount	integer	The maximum number of ephemeral storage disks.
storageSize	integer	The size of one ephemeral storage disk, in bytes.
vcpu	integer	The number of vCPUs.

{
  "ebsOptimizedAvailable": true,
  "ephemeralsType": "string",
  "eth": 0,
  "gpu": 0,
  "maxIpAddresses": 0,
  "memory": 0,
  "name": "string",
  "storageCount": 0,
  "storageSize": 0,
  "vcpu": 0
}

instancesSet_0

One or more instances.

Property	Type	Description
amiLaunchIndex	integer	The launch index of the OMI.
architecture	string	The architecture of the image.
blockDeviceMapping	[BlockDeviceMapping_3]	One or more entries of block device mapping.
clientToken	string	A unique identifier which enables you to manage the idempotency.
dnsName	string	The name of the public DNS assigned to the instance.
ebsOptimized	boolean	This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
groupSet	[groupSet]	One or more security groups for the instance.
hypervisor	string	The hypervisor type of the instance.
iamInstanceProfile	iamInstanceProfile	The EIM instance profile associated with the instance.
imageId	string	The ID of the OMI.
instanceId	string	The ID of the instance.
instanceLifecycle	string	Indicates whether it is a spot instance.
instanceState	instanceState	The state of the instance.
instanceType	string	The type of instance. For more information, see VM-Types.html">VM Types.
ipAddress	string	The External IP (EIP) assigned to the instance.
kernelId	string	The ID of the kernel (always `null`).
keyName	string	The name of the keypair.
launchTime	string	The time at which the instance was launched.
monitoring	monitoring	The monitoring information for the instance.
networkInterfaceSet	[networkInterfaceSet_0]	In a VPC, one or more network interfaces for the instance.
placement	Placement_1	A specific placement where you want to create the instances.
platform	string	Indicates whether it is a Windows instance.
privateDnsName	string	The name of the private DNS assigned to the instance.
privateIpAddress	string	The private IP assigned to the instance.
productCodes	[productCodes]	The product codes attached to the instance.
ramdiskId	string	The ID of the associated RAM disk.
reason	string	Information about the latest state change.
rootDeviceName	string	The name of the root device.
rootDeviceType	string	The type of root device used by the OMI.
sourceDestCheck	boolean	If true in a VPC, the check to perform NAT is enabled.
spotInstanceRequestId	string	The ID of the spot instance request.
sriovNetSupport	string	If true, the enhanced networking is enabled.
stateReason	stateReason	The reason for the OMI state change.
subnetId	string	In a VPC, the ID of the subnet in which you want to launch the instance.
tagSet	[tagSet_0]	One or more tags associated with the instance.
virtualizationType	string	The virtualization type.
vpcId	string	The ID of the VPC in which the instance is launched.

{
  "amiLaunchIndex": 0,
  "architecture": "string",
  "blockDeviceMapping": [
    {
      "deviceName": "string",
      "ebs": {
        "attachTime": "string",
        "deleteOnTermination": true,
        "status": "string",
        "volumeId": "string"
      }
    }
  ],
  "clientToken": "string",
  "dnsName": "string",
  "ebsOptimized": true,
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "hypervisor": "string",
  "iamInstanceProfile": {
    "arn": "string",
    "id": "string"
  },
  "imageId": "string",
  "instanceId": "string",
  "instanceLifecycle": "string",
  "instanceState": {
    "code": 0,
    "name": "string"
  },
  "instanceType": "string",
  "ipAddress": "string",
  "kernelId": "string",
  "keyName": "string",
  "launchTime": "string",
  "monitoring": {
    "state": "string"
  },
  "networkInterfaceSet": [
    {
      "association": {
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "attachment": {
        "attachTime": "string",
        "attachmentId": "string",
        "deleteOnTermination": true,
        "deviceIndex": 0,
        "status": "string"
      },
      "description": "string",
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "macAddress": "string",
      "networkInterfaceId": "string",
      "ownerId": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "privateIpAddressesSet": [
        {
          "association": {
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "primary": true,
          "privateDnsName": "string",
          "privateIpAddress": "string"
        }
      ],
      "sourceDestCheck": true,
      "status": "string",
      "subnetId": "string",
      "vpcId": "string"
    }
  ],
  "placement": {
    "availabilityZone": "string",
    "groupName": "string",
    "tenancy": "string"
  },
  "platform": "string",
  "privateDnsName": "string",
  "privateIpAddress": "string",
  "productCodes": [
    {
      "productCode": "string",
      "type": "string"
    }
  ],
  "ramdiskId": "string",
  "reason": "string",
  "rootDeviceName": "string",
  "rootDeviceType": "string",
  "sourceDestCheck": true,
  "spotInstanceRequestId": "string",
  "sriovNetSupport": "string",
  "stateReason": {
    "code": "string",
    "message": "string"
  },
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "virtualizationType": "string",
  "vpcId": "string"
}

instancesSet_1

One or more instances.

Property	Type	Description
currentState	currentState	The current state of the instance.
instanceId	string	The ID of the instance.
previousState	previousState	The previous state of the instance.

{
  "currentState": {
    "code": 0,
    "name": "string"
  },
  "instanceId": "string",
  "previousState": {
    "code": 0,
    "name": "string"
  }
}

internetGatewaySet

Information about the newly created internet gateway.

Property	Type	Description
attachmentSet	[attachmentSet_1]	One or more VPCs attached to the internet gateway.
internetGatewayId	string	The ID of the internet gateway.
tagSet	[tagSet_0]	One or more tags associated with the internet gateway.

{
  "attachmentSet": [
    {
      "state": "string",
      "vpcId": "string"
    }
  ],
  "internetGatewayId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

ipPermissionsEgress

The outbound rules associated with the security group.

Property	Type	Description
fromPort	integer	The beginning of the port range for TCP and UDP protocols, or an ICMP type number.
groups	[groups_2]	One or more security groups and account ID pairs.
ipProtocol	string	The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a VPC, this can also be an IP protocol number. For more information, see the IANA.org website.
ipRanges	[ipRanges_1]	One or more IP ranges.
prefixListIds	[PrefixListIds_1]	One or more prefix list IDs to allow traffic from a VPC to access the corresponding OUTSCALE services. For more information, see DescribePrefixLists.
toPort	integer	The end of the port range for TCP and UDP protocols, or an ICMP code number.

{
  "fromPort": 0,
  "groups": [
    {
      "groupId": "string",
      "groupName": "string",
      "userId": "string"
    }
  ],
  "ipProtocol": "string",
  "ipRanges": [
    {
      "cidrIp": "string"
    }
  ],
  "prefixListIds": [
    {
      "prefixListId": "string"
    }
  ],
  "toPort": 0
}

keySet

Information about one or more keypairs.

Property	Type	Description
keyFingerprint	string	The MD5 public key fingerprint as specified in section 4 of RFC 4716.
keyName	string	The name of the keypair.

{
  "keyFingerprint": "string",
  "keyName": "string"
}

launchPermission_1

One or more launch permissions.

Property	Type	Description
group	string	The name of the group (`all` if public).
userId	string	The ID of the account.

{
  "group": "string",
  "userId": "string"
}

monitoring

The monitoring information for the instance.

Property	Type	Description
state	string	The state of detail monitoring (`enabled` \| `disabled` \| `disabling` \| `pending`).

{
  "state": "string"
}

natGateway

Information about the newly created NAT gateway.

Property	Type	Description
createTime	string	The date and time when the NAT gateway was created.
deleteTime	string	The date and time when the NAT gateway was deleted, if applicable.
natGatewayAddressSet	[natGatewayAddressSet]	Information about the External IP (EIP) associated with the NAT gateway.
natGatewayId	string	The ID of the NAT gateway.
state	string	The state of the NAT gateway (`pending` \| `available` \| `deleting` \| `deleted`).
subnetId	string	The ID of the public subnet in which the NAT gateway is.
tagSet	[tagSet_0]	One or more tags associated with the NAT gateway.
vpcId	string	The ID of the VPC in which the NAT gateway is.

{
  "createTime": "string",
  "deleteTime": "string",
  "natGatewayAddressSet": [
    {
      "allocationId": "string",
      "networkInterfaceId": "string",
      "privateIp": "string",
      "publicIp": "string"
    }
  ],
  "natGatewayId": "string",
  "state": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

natGatewayAddressSet

Information about the External IP (EIP) associated with the NAT gateway.

Property	Type	Description
allocationId	string	The allocation ID of the External IP (EIP) associated with the NAT gateway.
networkInterfaceId	string	The ID of the network interface associated with the NAT gateway.
privateIp	string	The private IP associated with the EIP.
publicIp	string	The EIP associated with the NAT gateway.

{
  "allocationId": "string",
  "networkInterfaceId": "string",
  "privateIp": "string",
  "publicIp": "string"
}

natGatewaySet

Information about one or more NAT gateways.

Property	Type	Description
createTime	string	The date and time when the NAT gateway was created.
deleteTime	string	The date and time when the NAT gateway was deleted, if applicable.
natGatewayAddressSet	[natGatewayAddressSet]	Information about the External IP (EIP) associated with the NAT gateway.
natGatewayId	string	The ID of the NAT gateway.
state	string	The state of the NAT gateway (`pending` \| `available` \| `deleting` \| `deleted`).
subnetId	string	The ID of the public subnet in which the NAT gateway is.
tagSet	[tagSet_0]	One or more tags associated with the NAT gateway.
vpcId	string	The ID of the VPC in which the NAT gateway is.

{
  "createTime": "string",
  "deleteTime": "string",
  "natGatewayAddressSet": [
    {
      "allocationId": "string",
      "networkInterfaceId": "string",
      "privateIp": "string",
      "publicIp": "string"
    }
  ],
  "natGatewayId": "string",
  "state": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

networkInterfaceSet_0

In a VPC, one or more network interfaces for the instance.

Property	Type	Description
association	association_1	Information about an External IP associated with the interface.
attachment	attachment_2	The attachment of the network interface.
description	string	The description of the network interface.
groupSet	[groupSet]	One or more security groups for the FNI.
macAddress	string	The MAC address of the interface.
networkInterfaceId	string	The ID of the network interface.
ownerId	string	The account ID of the owner of the instance reservation.
privateDnsName	string	The name of the private DNS assigned to the instance.
privateIpAddress	string	The private IP assigned to the instance.
privateIpAddressesSet	[privateIpAddressesSet_1]	The private IPs assigned to the network interface.
sourceDestCheck	boolean	If true in a VPC, the check to perform NAT is enabled.
status	string	The state of the interface.
subnetId	string	In a VPC, the ID of the subnet in which to launch the instance.
vpcId	string	The ID of the VPC in which the instance is launched.

{
  "association": {
    "ipOwnerId": "string",
    "publicDnsName": "string",
    "publicIp": "string"
  },
  "attachment": {
    "attachTime": "string",
    "attachmentId": "string",
    "deleteOnTermination": true,
    "deviceIndex": 0,
    "status": "string"
  },
  "description": "string",
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "macAddress": "string",
  "networkInterfaceId": "string",
  "ownerId": "string",
  "privateDnsName": "string",
  "privateIpAddress": "string",
  "privateIpAddressesSet": [
    {
      "association": {
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "primary": true,
      "privateDnsName": "string",
      "privateIpAddress": "string"
    }
  ],
  "sourceDestCheck": true,
  "status": "string",
  "subnetId": "string",
  "vpcId": "string"
}

networkInterfaceSet_1

Information about the FNIs.

Property	Type	Description
association	association_0	Information about the association between the FNI and an EIP.
attachment	attachment_1	Information about the FNI attachment.
availabilityZone	string	The AZ where the FNI is located.
description	string	The description of the FNI.
groupSet	[groupSet]	One or more security groups for the FNI.
macAddress	string	The Media Access Control (MAC) address of the FNI.
networkInterfaceId	string	The ID of the FNI.
ownerId	string	The account ID of the FNI owner.
privateDnsName	string	The private DNS name associated with the primary private IP of the FNI.
privateIpAddress	string	The primary private IP of the FNI.
privateIpAddressesSet	[privateIpAddressesSet_0]	Information about the EIP and the private IPs assigned to the FNI.
sourceDestCheck	boolean	If true, the traffic to or from the instance is validated. If false, it is not.
status	string	The state of the FNI.
subnetId	string	The ID of the subnet where the FNI is located.
tagSet	[tagSet_0]	One or more tags associated with the FNI.
vpcId	string	The ID of the VPC where the FNI is located.

{
  "association": {
    "allocationId": "string",
    "associationId": "string",
    "ipOwnerId": "string",
    "publicDnsName": "string",
    "publicIp": "string"
  },
  "attachment": {
    "attachTime": "string",
    "attachmentId": "string",
    "deleteOnTermination": true,
    "deviceIndex": 0,
    "instanceId": "string",
    "instanceOwnerId": "string",
    "status": "string"
  },
  "availabilityZone": "string",
  "description": "string",
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "macAddress": "string",
  "networkInterfaceId": "string",
  "ownerId": "string",
  "privateDnsName": "string",
  "privateIpAddress": "string",
  "privateIpAddressesSet": [
    {
      "association": {
        "allocationId": "string",
        "associationId": "string",
        "ipOwnerId": "string",
        "publicDnsName": "string",
        "publicIp": "string"
      },
      "primary": true,
      "privateDnsName": "string",
      "privateIpAddress": "string"
    }
  ],
  "sourceDestCheck": true,
  "status": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

prefixListSet

Information about one or more prefix lists.

Property	Type	Description
cidrSet	[string]	The list of network prefixes used by the service, in CIDR notation.
prefixListId	string	The ID of the prefix list.
prefixListName	string	The name of the prefix list, which identifies the OUTSCALE service it is associated with.

{
  "cidrSet": [
    "string"
  ],
  "prefixListId": "string",
  "prefixListName": "string"
}

previousState

The previous state of the instance.

Property	Type	Description
code	integer	The code of the state of the instance: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).
name	string	The state of the instance (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).

{
  "code": 0,
  "name": "string"
}

privateIpAddressesSet_0

Information about the EIP and the private IPs assigned to the FNI.

Property	Type	Description
association	association_0	Information about the association between the FNI and an EIP.
primary	boolean	If true, the following private IP is the primary one. If false, it is a secondary one.
privateDnsName	string	The private DNS name associated with the primary private IP of the FNI.
privateIpAddress	string	A private IP assigned to the FNI.

{
  "association": {
    "allocationId": "string",
    "associationId": "string",
    "ipOwnerId": "string",
    "publicDnsName": "string",
    "publicIp": "string"
  },
  "primary": true,
  "privateDnsName": "string",
  "privateIpAddress": "string"
}

privateIpAddressesSet_1

The private IPs assigned to the network interface.

Property	Type	Description
association	association_1	Information about an External IP associated with the interface.
primary	boolean	If true, the IP is the primary address of the network interface.
privateDnsName	string	The name of the private DNS.
privateIpAddress	string	The private IP of the network interface.

{
  "association": {
    "ipOwnerId": "string",
    "publicDnsName": "string",
    "publicIp": "string"
  },
  "primary": true,
  "privateDnsName": "string",
  "privateIpAddress": "string"
}

productCodes

Information about one or more product codes.

Property	Type	Description
productCode	string	The product code associated with the OMI.
type	string	The type of the product code associated with the OMI.

{
  "productCode": "string",
  "type": "string"
}

productType

Information about the product type of the specified OMI or snapshot.

Property	Type	Description
description	string	The description of the product type.
productTypeId	string	The ID of the product type.
vendor	string	The vendor of the product type.

{
  "description": "string",
  "productTypeId": "string",
  "vendor": "string"
}

productTypeSet

Information about one or more product types.

Property	Type	Description
description	string	The description of the product type.
productTypeId	string	The ID of the product type.
vendor	string	The vendor of the product type.

{
  "description": "string",
  "productTypeId": "string",
  "vendor": "string"
}

propagatingVgwSet

Information about virtual private gateways propagating routes.

Property	Type	Description
gatewayId	string	The ID of the virtual private gateway.

{
  "gatewayId": "string"
}

ramdisk

The ID of the RAM disk.

Property	Type	Description
Value	string	The value specified for the resource attribute.

{
  "Value": "string"
}

referenceQuotaSet

One or more reference quotas.

Property	Type	Description
quotaSet	[QuotaSet]	One or more quotas associated with the account.
reference	string	The resource ID if it is a resource-specific quota, `global` if it is not.

{
  "quotaSet": [
    {
      "description": "string",
      "displayName": "string",
      "groupName": "string",
      "maxQuotaValue": 0,
      "name": "string",
      "ownerId": "string",
      "usedQuotaValue": 0
    }
  ],
  "reference": "string"
}

regionInfo

Information about one or more Regions.

Property	Type	Description
regionEndpoint	string	The hostname of the gateway to access the Region.
regionName	string	The administrative name of the Region.

{
  "regionEndpoint": "string",
  "regionName": "string"
}

requesterVpcInfo

Information about the source VPC of the VPC peering connection.

Property	Type	Description
cidrBlock	string	The CIDR block of the VPC.
ownerId	string	The account ID of the owner of the VPC.
vpcId	string	The ID of the VPC.

{
  "cidrBlock": "string",
  "ownerId": "string",
  "vpcId": "string"
}

reservationSet

Zero or more reservations.

Property	Type	Description
groupSet	[groupSet]	One or more security groups.
instancesSet	[instancesSet_0]	One or more instances.
ownerId	string	The account ID of the owner of the reservation.
requesterId	string	The ID of the requester that launched the instances on your behalf.
reservationId	string	The ID of the reservation.

{
  "groupSet": [
    {
      "groupId": "string",
      "groupName": "string"
    }
  ],
  "instancesSet": [
    {
      "amiLaunchIndex": 0,
      "architecture": "string",
      "blockDeviceMapping": [
        {
          "deviceName": "string",
          "ebs": {
            "attachTime": "string",
            "deleteOnTermination": true,
            "status": "string",
            "volumeId": "string"
          }
        }
      ],
      "clientToken": "string",
      "dnsName": "string",
      "ebsOptimized": true,
      "groupSet": [
        {
          "groupId": "string",
          "groupName": "string"
        }
      ],
      "hypervisor": "string",
      "iamInstanceProfile": {
        "arn": "string",
        "id": "string"
      },
      "imageId": "string",
      "instanceId": "string",
      "instanceLifecycle": "string",
      "instanceState": {
        "code": 0,
        "name": "string"
      },
      "instanceType": "string",
      "ipAddress": "string",
      "kernelId": "string",
      "keyName": "string",
      "launchTime": "string",
      "monitoring": {
        "state": "string"
      },
      "networkInterfaceSet": [
        {
          "association": {
            "ipOwnerId": "string",
            "publicDnsName": "string",
            "publicIp": "string"
          },
          "attachment": {
            "attachTime": "string",
            "attachmentId": "string",
            "deleteOnTermination": true,
            "deviceIndex": 0,
            "status": "string"
          },
          "description": "string",
          "groupSet": [
            {
              "groupId": "string",
              "groupName": "string"
            }
          ],
          "macAddress": "string",
          "networkInterfaceId": "string",
          "ownerId": "string",
          "privateDnsName": "string",
          "privateIpAddress": "string",
          "privateIpAddressesSet": [
            {
              "association": {
                "ipOwnerId": "string",
                "publicDnsName": "string",
                "publicIp": "string"
              },
              "primary": true,
              "privateDnsName": "string",
              "privateIpAddress": "string"
            }
          ],
          "sourceDestCheck": true,
          "status": "string",
          "subnetId": "string",
          "vpcId": "string"
        }
      ],
      "placement": {
        "availabilityZone": "string",
        "groupName": "string",
        "tenancy": "string"
      },
      "platform": "string",
      "privateDnsName": "string",
      "privateIpAddress": "string",
      "productCodes": [
        {
          "productCode": "string",
          "type": "string"
        }
      ],
      "ramdiskId": "string",
      "reason": "string",
      "rootDeviceName": "string",
      "rootDeviceType": "string",
      "sourceDestCheck": true,
      "spotInstanceRequestId": "string",
      "sriovNetSupport": "string",
      "stateReason": {
        "code": "string",
        "message": "string"
      },
      "subnetId": "string",
      "tagSet": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "virtualizationType": "string",
      "vpcId": "string"
    }
  ],
  "ownerId": "string",
  "requesterId": "string",
  "reservationId": "string"
}

rootDeviceName

The name of the root device.

Property	Type	Description
Value	string	The value specified for the resource attribute.

{
  "Value": "string"
}

routeSet

One or more routes in the route table.

Property	Type	Description
destinationCidrBlock	string	The CIDR block used to match the destination.
destinationPrefixListId	string	The prefix of the OUTSCALE service.
gatewayId	string	The ID of a gateway attached to the VPC.
instanceId	string	The ID of a NAT instance in your VPC.
instanceOwnerId	string	The account ID of the owner of the instance.
networkInterfaceId	string	The ID of the network interface.
origin	string	The method used to create the route.
state	string	The state of the route.
vpcPeeringConnectionId	string	The ID of the VPC peering connection.

{
  "destinationCidrBlock": "string",
  "destinationPrefixListId": "string",
  "gatewayId": "string",
  "instanceId": "string",
  "instanceOwnerId": "string",
  "networkInterfaceId": "string",
  "origin": "string",
  "state": "string",
  "vpcPeeringConnectionId": "string"
}

routeTable

Information about the newly created route table.

Property	Type	Description
associationSet	[associationSet]	One or more associations between the route table and the subnets.
propagatingVgwSet	[propagatingVgwSet]	Information about virtual private gateways propagating routes.
routeSet	[routeSet]	One or more routes in the route table.
routeTableId	string	The ID of the route table.
tagSet	[tagSet_0]	One or more tags associated with the route table.
vpcId	string	The ID of the VPC.

{
  "associationSet": [
    {
      "main": true,
      "routeTableAssociationId": "string",
      "routeTableId": "string",
      "subnetId": "string"
    }
  ],
  "propagatingVgwSet": [
    {
      "gatewayId": "string"
    }
  ],
  "routeSet": [
    {
      "destinationCidrBlock": "string",
      "destinationPrefixListId": "string",
      "gatewayId": "string",
      "instanceId": "string",
      "instanceOwnerId": "string",
      "networkInterfaceId": "string",
      "origin": "string",
      "state": "string",
      "vpcPeeringConnectionId": "string"
    }
  ],
  "routeTableId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

routeTableSet

Information about one or more route tables.

Property	Type	Description
associationSet	[associationSet]	One or more associations between the route table and the subnets.
propagatingVgwSet	[propagatingVgwSet]	Information about virtual private gateways propagating routes.
routeSet	[routeSet]	One or more routes in the route table.
routeTableId	string	The ID of the route table.
tagSet	[tagSet_0]	One or more tags associated with the route table.
vpcId	string	The ID of the VPC.

{
  "associationSet": [
    {
      "main": true,
      "routeTableAssociationId": "string",
      "routeTableId": "string",
      "subnetId": "string"
    }
  ],
  "propagatingVgwSet": [
    {
      "gatewayId": "string"
    }
  ],
  "routeSet": [
    {
      "destinationCidrBlock": "string",
      "destinationPrefixListId": "string",
      "gatewayId": "string",
      "instanceId": "string",
      "instanceOwnerId": "string",
      "networkInterfaceId": "string",
      "origin": "string",
      "state": "string",
      "vpcPeeringConnectionId": "string"
    }
  ],
  "routeTableId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

routes

Information about one or more static routes associated with the VPN connection, if any.

Property	Type	Description
destinationCidrBlock	string	The destination range of IPs of the route corresponding to your local network, in CIDR notation.
source	string	The type of route (always `static`).
state	string	The current state of the static route (`pending` \| `available` \| `deleting` \| `deleted`).

{
  "destinationCidrBlock": "string",
  "source": "string",
  "state": "string"
}

securityGroupInfo

Information about one or more security groups.

Property	Type	Description
groupDescription	string	A description of the security group.
groupId	string	The ID of the security group.
groupName	string	The name of the security group.
ipPermissions	[IpPermissions_1]	The inbound rules associated with the security group.
ipPermissionsEgress	[ipPermissionsEgress]	The outbound rules associated with the security group.
ownerId	string	The account ID of the owner of the security group.
tagSet	[tagSet_0]	One or more tags associated with the security group.
vpcId	string	The ID of the VPC for the security group.

{
  "groupDescription": "string",
  "groupId": "string",
  "groupName": "string",
  "ipPermissions": [
    {
      "fromPort": 0,
      "groups": [
        {
          "groupId": "string",
          "groupName": "string",
          "userId": "string"
        }
      ],
      "ipProtocol": "string",
      "ipRanges": [
        {
          "cidrIp": "string"
        }
      ],
      "prefixListIds": [
        {
          "prefixListId": "string"
        }
      ],
      "toPort": 0
    }
  ],
  "ipPermissionsEgress": [
    {
      "fromPort": 0,
      "groups": [
        {
          "groupId": "string",
          "groupName": "string",
          "userId": "string"
        }
      ],
      "ipProtocol": "string",
      "ipRanges": [
        {
          "cidrIp": "string"
        }
      ],
      "prefixListIds": [
        {
          "prefixListId": "string"
        }
      ],
      "toPort": 0
    }
  ],
  "ownerId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

snapshotExport

Information about the snapshot you want to export.

Property	Type	Description
snapshotId	string	The ID of snapshot to be exported.

{
  "snapshotId": "string"
}

snapshotExportTask

Information about one or more snapshot export tasks.

Property	Type	Description
completion	integer	The percentage of the task completed.
exportToOsu	exportToOsu_3	Information about the snapshot export task.
snapshotExport	snapshotExport	Information about the snapshot you want to export.
snapshotExportTaskId	string	The ID of the snapshot export task.
state	string	The state of the snapshot export task (`pending` \| `active` \| `completed` \| `failed`).
statusMessage	string	If the snapshot export task fails, an error message.
tagSet	[tagSet_0]	One or more tags associated with the snapshot export task.

{
  "completion": 0,
  "exportToOsu": {
    "diskImageFormat": "string",
    "osuBucket": "string",
    "osuKey": "string",
    "osuPrefix": "string",
    "aksk": {
      "AccessKey": "string",
      "SecretKey": "string"
    }
  },
  "snapshotExport": {
    "snapshotId": "string"
  },
  "snapshotExportTaskId": "string",
  "state": "string",
  "statusMessage": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

snapshotSet

Information about one or more snapshots.

Property	Type	Description
description	string	The description of the snapshot.
encrypted	boolean	Indicates whether the snapshot is encrypted or not (always false).
ownerAlias	string	The account alias of the owner of the snapshot.
ownerId	string	The account ID of owner of the snapshot.
progress	string	The progress of the snapshot, as a percentage.
snapshotId	string	The unique ID of the snapshot.
startTime	string	The time at which the snapshot was initiated.
status	string	The state of the snapshot (`in-queue` \| `pending` \| `completed` \| `error` \| `deleting`).
statusMessage	string	The error message in case of snapshot copy operation failure.
tagSet	[tagSet_0]	One or more tags associated with the snapshot.
volumeId	string	The ID of the volume used to create the snapshot.
volumeSize	integer	The size of the volume used to create the snapshot, in gibibytes (GiB).

{
  "description": "string",
  "encrypted": true,
  "ownerAlias": "string",
  "ownerId": "string",
  "progress": "string",
  "snapshotId": "string",
  "startTime": "string",
  "status": "string",
  "statusMessage": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeSize": 0
}

stateReason

The reason for the OMI state change.

Property	Type	Description
code	string	The code of the change of state.
message	string	The message explaining the change of state.

{
  "code": "string",
  "message": "string"
}

status

The state of the VPC peering connection.

Property	Type	Description
code	string	The state of the VPC peering connection (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
message	string	Additional information about the state of the VPC peering connection.

{
  "code": "string",
  "message": "string"
}

subnet

Information about the newly created subnet.

Property	Type	Description
availabilityZone	string	The name of the Availability Zone in which the subnet is located.
availableIpAddressCount	integer	The number of unused IPs in the subnet.
cidrBlock	string	The CIDR block of the subnet (for example, `10.84.7.0/24`).
mapPublicIpOnLaunch	boolean	Specifies whether an External IP (EIP) is assigned to the instances launched in this subnet.
state	string	The state of the subnet (`pending` \| `available` \| `deleted`).
subnetId	string	The ID of the subnet.
tagSet	[tagSet_0]	One or more tags associated with the VPC.
vpcId	string	The ID of the VPC where the subnet is.

{
  "availabilityZone": "string",
  "availableIpAddressCount": 0,
  "cidrBlock": "string",
  "mapPublicIpOnLaunch": true,
  "state": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

subnetSet

Information about one or more of your subnets.

Property	Type	Description
availabilityZone	string	The name of the Availability Zone in which the subnet is located.
availableIpAddressCount	integer	The number of unused IPs in the subnet.
cidrBlock	string	The CIDR block of the subnet (for example, `10.84.7.0/24`).
mapPublicIpOnLaunch	boolean	Specifies whether an External IP (EIP) is assigned to the instances launched in this subnet.
state	string	The state of the subnet (`pending` \| `available` \| `deleted`).
subnetId	string	The ID of the subnet.
tagSet	[tagSet_0]	One or more tags associated with the VPC.
vpcId	string	The ID of the VPC where the subnet is.

{
  "availabilityZone": "string",
  "availableIpAddressCount": 0,
  "cidrBlock": "string",
  "mapPublicIpOnLaunch": true,
  "state": "string",
  "subnetId": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

systemStatus

Impaired functionality that stems from issues related to the systems supporting an instance (for example, hardware failures or network connectivity problems).

Property	Type	Description
details	[details]	The system instance health or application instance health.
status	string	The state of the instance.

{
  "details": [
    {
      "impairedSince": "string",
      "name": "string",
      "status": "string"
    }
  ],
  "status": "string"
}

tagSet_0

One or more tags associated with the resource.

Property	Type	Description
key	string	The key of the tag, with a minimum of 1 character.
value	string	The value of the tag, between 0 and 255 characters.

{
  "key": "string",
  "value": "string"
}

tagSet_1

Information about one or more tags.

Property	Type	Description
key	string	The key of the tag.
resourceId	string	The ID of the resource the tag is associated with.
resourceType	string	The type of resource the tag is associated with.
value	string	The value of the tag.

{
  "key": "string",
  "resourceId": "string",
  "resourceType": "string",
  "value": "string"
}

unsuccessful

Information about one or more unsuccessfully deleted VPC endpoints.

Property	Type	Description
error	error	Information about the error.
resourceId	string	The ID of the resource.

{
  "error": {
    "code": "string",
    "message": "string"
  },
  "resourceId": "string"
}

valueSet

The value for the option in the DHCP configuration.

Property	Type	Description
value	string	The value specified for the resource attribute.

{
  "value": "string"
}

vgwTelemetry

Information about the current state of VPN tunnels.

Property	Type	Description
acceptedRouteCount	integer	The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
lastStatusChange	string	The time of the latest state update.
outsideIpAddress	string	The IP on the OUTSCALE side of the tunnel.
status	string	The status of the IPSEC tunnel (`UP` \| `DOWN`).
statusMessage	string	A description of the current state of the tunnel.

{
  "acceptedRouteCount": 0,
  "lastStatusChange": "string",
  "outsideIpAddress": "string",
  "status": "string",
  "statusMessage": "string"
}

volumeSet

Information about one or more volumes.

Property	Type	Description
attachmentSet	[attachmentSet_0]	Information about your volume attachment.
availabilityZone	string	The Availability Zone where the volume is.
createTime	string	The date and time of creation of the volume.
iops	integer	The number of I/O operations per second: - For io1 volumes, the number of provisioned IOPS - For gp2 volumes, the baseline performance of the volume
size	integer	The size of the volume, in gibibytes (GiB).
snapshotId	string	The ID of the snapshot from which the volume was created.
status	string	The state of the volume (`creating` \| `available` \| `in-use` \| `deleting` \| `error`).
tagSet	[tagSet_0]	One or more tags associated with the volume.
volumeId	string	The ID of the volume.
volumeType	string	The type of the volume (`standard` \| `gp2` \| `io1`).

{
  "attachmentSet": [
    {
      "attachTime": "string",
      "deleteOnTermination": true,
      "device": "string",
      "instanceId": "string",
      "status": "string",
      "volumeId": "string"
    }
  ],
  "availabilityZone": "string",
  "createTime": "string",
  "iops": 0,
  "size": 0,
  "snapshotId": "string",
  "status": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "volumeId": "string",
  "volumeType": "string"
}

vpc

Information about the newly created VPC.

Property	Type	Description
cidrBlock	string	The CIDR block of the VPC, in the [16;28] range (for example, `10.84.7.0/24`).
dhcpOptionsId	string	The ID of the DHCP options set associated with the VPC.
instanceTenancy	string	The tenancy of the instances (`default` if an instance created in a VPC can be launched with any tenancy, `dedicated` if it can be launched with dedicated tenancy instances running on single-tenant hardware).
isDefault	boolean	Indicates whether the VPC is the default one (always `false`).
state	string	The state of the VPC (`pending` \| `available` \| `deleted`).
tagSet	[tagSet_0]	One or more tags associated with the VPC.
vpcId	string	The ID of the Virtual Private Cloud (VPC).

{
  "cidrBlock": "string",
  "dhcpOptionsId": "string",
  "instanceTenancy": "string",
  "isDefault": true,
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

vpcEndpoint

Information about the newly created VPC endpoint.

Property	Type	Description
creationTimestamp	string	The date and time of creation of the VPC endpoint.
routeTableIdSet	[string]	The ID of the route tables associated with the VPC endpoint.
serviceName	string	The name of the prefix list corresponding to the service with which the VPC endpoint is associated.
state	string	The state of the VPC endpoint (`pending` \| `available` \| `deleting` \| `deleted`).
vpcEndpointId	string	The ID of the VPC endpoint.
vpcId	string	The ID of the VPC with which the VPC endpoint is associated.

{
  "creationTimestamp": "string",
  "routeTableIdSet": [
    "string"
  ],
  "serviceName": "string",
  "state": "string",
  "vpcEndpointId": "string",
  "vpcId": "string"
}

vpcEndpointSet

Information about one or more VPC endpoints.

Property	Type	Description
creationTimestamp	string	The date and time of creation of the VPC endpoint.
routeTableIdSet	[string]	The ID of the route tables associated with the VPC endpoint.
serviceName	string	The name of the prefix list corresponding to the service with which the VPC endpoint is associated.
state	string	The state of the VPC endpoint (`pending` \| `available` \| `deleting` \| `deleted`).
vpcEndpointId	string	The ID of the VPC endpoint.
vpcId	string	The ID of the VPC with which the VPC endpoint is associated.

{
  "creationTimestamp": "string",
  "routeTableIdSet": [
    "string"
  ],
  "serviceName": "string",
  "state": "string",
  "vpcEndpointId": "string",
  "vpcId": "string"
}

vpcPeeringConnection

Information about the created VPC peering connection.

Property	Type	Description
accepterVpcInfo	accepterVpcInfo	Information about the peer VPC of the VPC peering connection.
expirationTime	string	The time after which a VPC peering connection request in the `pending-acceptance` state expires.
requesterVpcInfo	requesterVpcInfo	Information about the source VPC of the VPC peering connection.
status	status	The state of the VPC peering connection.
tagSet	[tagSet_0]	One or more tags associated with the VPC peering connection.
vpcPeeringConnectionId	string	The ID of the VPC peering connection.

{
  "accepterVpcInfo": {
    "cidrBlock": "string",
    "ownerId": "string",
    "vpcId": "string"
  },
  "expirationTime": "string",
  "requesterVpcInfo": {
    "cidrBlock": "string",
    "ownerId": "string",
    "vpcId": "string"
  },
  "status": {
    "code": "string",
    "message": "string"
  },
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcPeeringConnectionId": "string"
}

vpcPeeringConnectionSet

Information about one or more VPC peering connections.

Property	Type	Description
accepterVpcInfo	accepterVpcInfo	Information about the peer VPC of the VPC peering connection.
expirationTime	string	The time after which a VPC peering connection request in the `pending-acceptance` state expires.
requesterVpcInfo	requesterVpcInfo	Information about the source VPC of the VPC peering connection.
status	status	The state of the VPC peering connection.
tagSet	[tagSet_0]	One or more tags associated with the VPC peering connection.
vpcPeeringConnectionId	string	The ID of the VPC peering connection.

{
  "accepterVpcInfo": {
    "cidrBlock": "string",
    "ownerId": "string",
    "vpcId": "string"
  },
  "expirationTime": "string",
  "requesterVpcInfo": {
    "cidrBlock": "string",
    "ownerId": "string",
    "vpcId": "string"
  },
  "status": {
    "code": "string",
    "message": "string"
  },
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcPeeringConnectionId": "string"
}

vpcSet

Information about the specified and described VPCs.

Property	Type	Description
cidrBlock	string	The CIDR block of the VPC, in the [16;28] range (for example, `10.84.7.0/24`).
dhcpOptionsId	string	The ID of the DHCP options set associated with the VPC.
isDefault	boolean	Indicates whether the VPC is the default one (always `false`).
instanceTenancy	string	The tenancy of the instances (`default` if an instance created in a VPC can be launched with any tenancy, `dedicated` if it can be launched with dedicated tenancy instances running on single-tenant hardware).
state	string	The state of the VPC (`pending` \| `available` \| `deleting`).
tagSet	[tagSet_0]	One or more tags associated with the VPC.
vpcId	string	The ID of the Virtual Private Cloud (VPC).

{
  "cidrBlock": "string",
  "dhcpOptionsId": "string",
  "isDefault": true,
  "instanceTenancy": "string",
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "vpcId": "string"
}

vpnConnection

Information about the VPN connection.

Property	Type	Description
customerGatewayConfiguration	string	Example configuration for the customer gateway, in XML format.
customerGatewayId	string	The ID of the customer gateway used on the customer end of the connection.
options	Options_1	Options for a VPN connection.
routes	[routes]	Information about one or more static routes associated with the VPN connection, if any.
state	string	The state of the VPN connection.
tagSet	[tagSet_0]	One or more tags associated with the VPN connection.
type	string	The type of VPN connection (always `ipsec.1`).
vgwTelemetry	[vgwTelemetry]	Information about the current state of VPN tunnels.
vpnConnectionId	string	The ID of the VPN connection.
vpnGatewayId	string	The ID of the virtual private gateway used on the OUTSCALE end of the connection.

{
  "customerGatewayConfiguration": "string",
  "customerGatewayId": "string",
  "options": {
    "staticRoutesOnly": true
  },
  "routes": [
    {
      "destinationCidrBlock": "string",
      "source": "string",
      "state": "string"
    }
  ],
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "type": "string",
  "vgwTelemetry": [
    {
      "acceptedRouteCount": 0,
      "lastStatusChange": "string",
      "outsideIpAddress": "string",
      "status": "string",
      "statusMessage": "string"
    }
  ],
  "vpnConnectionId": "string",
  "vpnGatewayId": "string"
}

vpnConnectionSet

Information about one or more VPN connections.

Property	Type	Description
customerGatewayConfiguration	string	Example configuration for the customer gateway, in XML format.
customerGatewayId	string	The ID of the customer gateway used on the customer end of the connection.
options	Options_1	Options for a VPN connection.
routes	[routes]	Information about one or more static routes associated with the VPN connection, if any.
state	string	The state of the VPN connection.
tagSet	[tagSet_0]	One or more tags associated with the VPN connection.
type	string	The type of VPN connection (always `ipsec.1`).
vgwTelemetry	[vgwTelemetry]	Information about the current state of VPN tunnels.
vpnConnectionId	string	The ID of the VPN connection.
vpnGatewayId	string	The ID of the virtual private gateway used on the OUTSCALE end of the connection.

{
  "customerGatewayConfiguration": "string",
  "customerGatewayId": "string",
  "options": {
    "staticRoutesOnly": true
  },
  "routes": [
    {
      "destinationCidrBlock": "string",
      "source": "string",
      "state": "string"
    }
  ],
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "type": "string",
  "vgwTelemetry": [
    {
      "acceptedRouteCount": 0,
      "lastStatusChange": "string",
      "outsideIpAddress": "string",
      "status": "string",
      "statusMessage": "string"
    }
  ],
  "vpnConnectionId": "string",
  "vpnGatewayId": "string"
}

vpnGateway

Information about the newly created virtual private gateway.

Property	Type	Description
attachments	[attachments]	The VPC to which the virtual private gateway is attached.
state	string	The state of the virtual private gateway (`pending` \| `available` \| `deleting` \| `deleted`).
tagSet	[tagSet]	One or more tags associated with the virtual private gateway.
type	string	The type of VPN connection supported by the virtual private gateway (always `ipsec.1`).
vpnGatewayId	string	The ID of the virtual private gateway.

{
  "attachments": [
    {
      "state": "string",
      "vpcId": "string"
    }
  ],
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "type": "string",
  "vpnGatewayId": "string"
}

vpnGatewaySet

Information about one or more virtual private gateways.

Property	Type	Description
attachments	[Attachments]	The VPC to which the virtual private gateway is attached.
state	string	The state of the virtual private gateway (`pending` \| `available` \| `deleting` \| `deleted`).
tagSet	[tagSet]	One or more tags associated with the virtual private gateway.
type	string	The type of VPN connection supported by the virtual private gateway (always `ipsec.1`).
vpnGatewayId	string	The ID of the virtual private gateway.

{
  "attachments": [],
  "state": "string",
  "tagSet": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "type": "string",
  "vpnGatewayId": "string"
}

OSC CLI Shell

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.

Body Parameter	Type	Description
ResourceId (required)	[string]	One or more resource IDs.
Tag (required)	[Tag]	One or more tags you want to add to the specified resources.Example for an instance: `osc-cli fcu CreateTags \` `--ResourceId i-xxxxxxxx \` `--Tag.1.Key "AAAA" --Tag.1.Value "BBBB"\` `--Tag.2.Key "CCCC" --Tag.2.Value "DDDD"`
Key	string	The key of the tag, with a minimum of 1 character.
Value	string	The value of the tag, between 0 and 255 characters.