describe-installation-media¶

Description¶

Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

Synopsis¶

  describe-installation-media
[--installation-media-id <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--installation-media-id (string)

The installation medium ID.

--filters (list)

A filter that specifies one or more installation media to describe. Supported filters include the following:

custom-availability-zone-id - Accepts custom Availability Zone (AZ) identifiers. The results list includes information about only the custom AZs identified by these identifiers.

engine - Accepts database engines. The results list includes information about only the database engines identified by these identifiers. For more information about the valid engines for installation media, see ImportInstallationMedia .

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:

DescribeDBClusterBacktracks

DescribeDBClusterEndpoints

DescribeDBClusters

DescribeDBInstances

DescribePendingMaintenanceActions

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

One or more filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe the installation media

The following describe-installation-media example describes the installation media in the AWS Region.

aws rds describe-installation-media

Output:

{
    "InstallationMedia": [
        {
            "InstallationMediaId": "ahIOEXAMPLE",
            "CustomAvailabilityZoneId": "rds-caz-EXAMPLE1",
            "Engine": "sqlserver-ee",
            "EngineVersion": "13.00.5292.0.v1",
            "EngineInstallationMediaPath": "SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso",
            "OSInstallationMediaPath": "WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso",
            "Status": "Available",
            "FailureCause": {}
        },
        {
            "InstallationMediaId": "AzHmpfEXample",
            "CustomAvailabilityZoneId": "rds-caz-EXAMPLE2",
            "Engine": "sqlserver-ee",
            "EngineVersion": "13.00.5292.0.v1",
            "EngineInstallationMediaPath": "SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso",
            "OSInstallationMediaPath": "WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso",
            "Status": "Importing",
            "FailureCause": {}
        }
    ]
}

For more information, see What is Amazon RDS on VMware? in the Amazon RDS on VMware User Guide.

Output¶

Marker -> (string)

An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

InstallationMedia -> (list)

The list of InstallationMedia objects for the AWS account.

(structure)

Contains the installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

InstallationMediaId -> (string)

The installation medium ID.

CustomAvailabilityZoneId -> (string)

The custom Availability Zone (AZ) that contains the installation media.

Engine -> (string)

The DB engine.

EngineVersion -> (string)

The engine version of the DB engine.

EngineInstallationMediaPath -> (string)

The path to the installation medium for the DB engine.

OSInstallationMediaPath -> (string)

The path to the installation medium for the operating system associated with the DB engine.

Status -> (string)

The status of the installation medium.

FailureCause -> (structure)

If an installation media failure occurred, the cause of the failure.

Message -> (string)

The reason that an installation media import failed.

Table of Contents

Feedback

User Guide