Installing and Configuring AWS CLI

You can manage your OUTSCALE Cloud resources using AWS CLI, a command-line interface (CLI) developed by Amazon Web Services™.

AWS CLI is compatible with all our AWS-compliant API services. For an advanced use of AWS CLI, see Installing and Configuring AWS CLI.

On January 16, 2025, Amazon Web Services (AWS) introduced new default algorithms for integrity protection when uploading and downloading data using the S3 API. For more information, see AWS SDK and CLI Compatibility Warning.

Installing and Configuring AWS CLI

  1. Install AWS CLI. For more information, see the official AWS CLI documentation.

  2. Type the following command in your terminal:

    $ aws configure

  3. Specify the configuration elements:

    • AWS Access Key ID: Your OUTSCALE Access Key.

    • AWS Secret Access Key: Your OUTSCALE Secret Key. For more information, see Getting Information About Your Access Keys.

    • Default region name: The name of the OUTSCALE Cloud Region you want to use. For more information, see About Regions and Subregions.

    • Default output format: This must be set to json.

      This command sets up a default, unnamed profile. To set up a different, named profile for each Region that you can use, use the --profile option following this syntax.

      $ aws configure --profile YOUR_PROFILE

Using AWS CLI

Sending a Request

To send a request to an AWS-compliant API, specify in your command:

  • The name of a compatible AWS API.

    The following AWS APIs are compatible with OUTSCALE services:

    • ec2 for FCU

    • elb for LBU

    • iam for EIM

    • directconnect for DirectLink

    • s3api for OOS

  • The name of the command.

  • (optional) The named profile using the --profile option.

  • The endpoint using the --endpoint option. For more information, see API Endpoints Reference.

  • Any other option required by the command.

Request sample
$ aws ec2 describe-instances \
    --profile YOUR_PROFILE \
    --endpoint https://fcu.eu-west-2.outscale.com

Configuring the Endpoint Attribute

If you want to leverage AWS CLI with the OUTSCALE Cloud without specifying the different endpoints every time, you can make the attribute optional as follows:

Ensure you update the endpoints when 3DS OUTSCALE releases new Regions and services. For more information, see About Regions and Subregions.
~/.aws/models/endpoints.json
{
  "partitions": [
    {
      "defaults": {
        "hostname": "{service}.{region}.{dnsSuffix}",
        "protocols": [
          "https"
        ],
        "signatureVersions": [
          "v4"
        ]
      },
      "dnsSuffix": "outscale.com",
      "partition": "osc",
      "partitionName": "Outscale",
      "regionRegex": "^(cloudgouv|us|eu|ap)\\-\\w+\\-\\d+$",
      "regions": {
        "eu-west-2": {
          "description": "EU (Paris)"
        },
        "cloudgouv-eu-west-1": {
          "description": "CloudGouv EU (Paris)"
        },
        "us-east-2": {
          "description": "US East (NY)"
        },
        "us-west-1": {
          "description": "US West (California)"
        },
        "ap-northeast-1": {
          "description": "Japan (Tokyo)"
        }
      },
      "services": {
        "ec2": {
          "endpoints": {
            "eu-west-2": {"hostname": "fcu.eu-west-2.outscale.com"},
            "cloudgouv-eu-west-1": {"hostname": "fcu.cloudgouv-eu-west-1.outscale.com"},
            "us-east-2": {"hostname": "fcu.us-east-2.outscale.com"},
            "us-west-1": {"hostname": "fcu.us-west-1.outscale.com"},
            "ap-northeast-1": {"hostname": "fcu.ap-northeast-1.outscale.com"}
          }
        },
       "elasticloadbalancing": {
          "endpoints": {
            "eu-west-2": {"hostname": "lbu.eu-west-2.outscale.com"},
            "cloudgouv-eu-west-1": {"hostname": "lbu.cloudgouv-eu-west-1.outscale.com"},
            "us-east-2": {"hostname": "lbu.us-east-2.outscale.com"},
            "us-west-1": {"hostname": "lbu.us-west-1.outscale.com"},
            "ap-northeast-1": {"hostname": "lbu.ap-northeast-1.outscale.com"}
          }
        },
        "iam": {
          "endpoints": {
            "eu-west-2": {"hostname": "eim.eu-west-2.outscale.com"},
            "cloudgouv-eu-west-1": {"hostname": "eim.cloudgouv-eu-west-1.outscale.com"},
            "us-east-2": {"hostname": "eim.us-east-2.outscale.com"},
            "us-west-1": {"hostname": "eim.us-west-1.outscale.com"},
            "ap-northeast-1": {"hostname": "eim.ap-northeast-1.outscale.com"}
          }
        },
        "directconnect": {
          "endpoints": {
            "eu-west-2": {"hostname": "directlink.eu-west-2.outscale.com"},
            "cloudgouv-eu-west-1": {"hostname": "directlink.cloudgouv-eu-west-1.outscale.com"},
            "us-east-2": {"hostname": "directlink.us-east-2.outscale.com"},
            "us-west-1": {"hostname": "directlink.us-west-1.outscale.com"}
          }
        },
        "s3": {
          "endpoints": {
            "eu-west-2": {"hostname": "oos.eu-west-2.outscale.com"},
            "cloudgouv-eu-west-1": {"hostname": "oos.cloudgouv-eu-west-1.outscale.com"},
            "us-east-2": {"hostname": "oos.us-east-2.outscale.com"},
            "us-west-1": {"hostname": "oos.us-west-1.outscale.com"}
          }
        }
      }
    }
  ],
  "version": 3
}

Using this new model changes the syntax of your AWS CLI commands:

Before
aws ec2 describe-instances --instance-ids i-12345678 i-87654321 i-12348765 i-56784321 --endpoint https://fcu.eu-west-2.outscale.com
After
aws ec2 describe-instances --instance-ids i-12345678 i-87654321 i-12348765 i-56784321

You will need to use the parameter region to switch from a Region to another.

For more information about AWS CLI command lines, see the AWS Command Reference.

Related Pages

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.

Export to PDF