AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . migrationhubstrategy ]

put-portfolio-preferences

Description

Saves the specified migration and modernization preferences.

See also: AWS API Documentation

Synopsis

  put-portfolio-preferences
[--application-mode <value>]
[--application-preferences <value>]
[--database-preferences <value>]
[--prioritize-business-goals <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--application-mode (string)

The classification for application component types.

Possible values:

  • ALL
  • KNOWN
  • UNKNOWN

--application-preferences (structure)

The transformation preferences for non-database applications.

managementPreference -> (tagged union structure)

Application preferences that you specify to prefer managed environment.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: awsManagedResources, noPreference, selfManageResources.

awsManagedResources -> (structure)

Indicates interest in solutions that are managed by AWS.

targetDestination -> (list)

The choice of application destination that you specify.

(string)

noPreference -> (structure)

No specific preference.

targetDestination -> (list)

The choice of application destination that you specify.

(string)

selfManageResources -> (structure)

Indicates interest in managing your own resources on AWS.

targetDestination -> (list)

Self-managed resources target destination.

(string)

JSON Syntax:

{
  "managementPreference": {
    "awsManagedResources": {
      "targetDestination": ["None specified"|"AWS Elastic BeanStalk"|"AWS Fargate", ...]
    },
    "noPreference": {
      "targetDestination": ["None specified"|"AWS Elastic BeanStalk"|"AWS Fargate"|"Amazon Elastic Cloud Compute (EC2)"|"Amazon Elastic Container Service (ECS)"|"Amazon Elastic Kubernetes Service (EKS)", ...]
    },
    "selfManageResources": {
      "targetDestination": ["None specified"|"Amazon Elastic Cloud Compute (EC2)"|"Amazon Elastic Container Service (ECS)"|"Amazon Elastic Kubernetes Service (EKS)", ...]
    }
  }
}

--database-preferences (structure)

The transformation preferences for database applications.

databaseManagementPreference -> (string)

Specifies whether you're interested in self-managed databases or databases managed by AWS.

databaseMigrationPreference -> (tagged union structure)

Specifies your preferred migration path.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: heterogeneous, homogeneous, noPreference.

heterogeneous -> (structure)

Indicates whether you are interested in moving from one type of database to another. For example, from SQL Server to Amazon Aurora MySQL-Compatible Edition.

targetDatabaseEngine -> (list)

The target database engine for heterogeneous database migration preference.

(string)

homogeneous -> (structure)

Indicates whether you are interested in moving to the same type of database into AWS. For example, from SQL Server in your environment to SQL Server on AWS.

targetDatabaseEngine -> (list)

The target database engine for homogeneous database migration preferences.

(string)

noPreference -> (structure)

Indicated that you do not prefer heterogeneous or homogeneous.

targetDatabaseEngine -> (list)

The target database engine for database migration preference that you specify.

(string)

JSON Syntax:

{
  "databaseManagementPreference": "AWS-managed"|"Self-manage"|"No preference",
  "databaseMigrationPreference": {
    "heterogeneous": {
      "targetDatabaseEngine": ["None specified"|"Amazon Aurora"|"AWS PostgreSQL"|"MySQL"|"Microsoft SQL Server"|"Oracle Database"|"MariaDB"|"SAP"|"Db2 LUW"|"MongoDB", ...]
    },
    "homogeneous": {
      "targetDatabaseEngine": ["None specified", ...]
    },
    "noPreference": {
      "targetDatabaseEngine": ["None specified"|"Amazon Aurora"|"AWS PostgreSQL"|"MySQL"|"Microsoft SQL Server"|"Oracle Database"|"MariaDB"|"SAP"|"Db2 LUW"|"MongoDB", ...]
    }
  }
}

--prioritize-business-goals (structure)

The rank of the business goals based on priority.

businessGoals -> (structure)

Rank of business goals based on priority.

licenseCostReduction -> (integer)

Business goal to reduce license costs.

modernizeInfrastructureWithCloudNativeTechnologies -> (integer)

Business goal to modernize infrastructure by moving to cloud native technologies.

reduceOperationalOverheadWithManagedServices -> (integer)

Business goal to reduce the operational overhead on the team by moving into managed services.

speedOfMigration -> (integer)

Business goal to achieve migration at a fast pace.

Shorthand Syntax:

businessGoals={licenseCostReduction=integer,modernizeInfrastructureWithCloudNativeTechnologies=integer,reduceOperationalOverheadWithManagedServices=integer,speedOfMigration=integer}

JSON Syntax:

{
  "businessGoals": {
    "licenseCostReduction": integer,
    "modernizeInfrastructureWithCloudNativeTechnologies": integer,
    "reduceOperationalOverheadWithManagedServices": integer,
    "speedOfMigration": integer
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

None