DescribeInstallationMedia - Amazon Relational Database Service

DescribeInstallationMedia

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Filters.Filter.N

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 .

Type: Array of Filter objects

Required: No

InstallationMediaId

The installation medium ID.

Type: String

Required: No

Marker

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

Type: String

Required: No

MaxRecords

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.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

InstallationMedia.InstallationMedia.N

The list of InstallationMedia objects for the AWS account.

Type: Array of InstallationMedia objects

Marker

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InstallationMediaNotFound

InstallationMediaID doesn't refer to an existing installation medium.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of DescribeInstallationMedia.

Sample Request

https://rds.us-east-1.amazonaws.com/ ?Action=DescribeInstallationMedia &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AIDACKCEVSQ6C2EXAMPLE/20201217/us-east-1/rds/aws4_request &X-Amz-Date=20201217T223855Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=ced6826de92d2bdeed8f846f0bf508e8559e98e4b0194b84example54174deb456c

Sample Response

<DescribeInstallationMediaResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <DescribeInstallationMediaResult> <InstallationMedia> <InstallationMedia> <EngineVersion>13.00.5292.0.v1</EngineVersion> <Engine>sqlserver-ee</Engine> <EngineInstallationMediaPath>SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso</EngineInstallationMediaPath> <OSInstallationMediaPath>WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso</OSInstallationMediaPath> <InstallationMediaId>ahIOEXAMPLE</InstallationMediaId> <CustomAvailabilityZoneId>rds-caz-EXAMPLE1</CustomAvailabilityZoneId> <FailureCause/> <Status>Available</Status> </InstallationMedia> <InstallationMedia> <EngineVersion>13.00.5292.0.v1</EngineVersion> <Engine>sqlserver-ee</Engine> <EngineInstallationMediaPath>SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso</EngineInstallationMediaPath> <OSInstallationMediaPath>WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso</OSInstallationMediaPath> <InstallationMediaId>AzHmpfEXample</InstallationMediaId> <CustomAvailabilityZoneId>rds-caz-EXAMPLE2</CustomAvailabilityZoneId> <FailureCause/> <Status>Available</Status> </InstallationMedia> <InstallationMedia> <EngineVersion>13.00.5292.0.v1</EngineVersion> <Engine>sqlserver-ee</Engine> <EngineInstallationMediaPath>SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso</EngineInstallationMediaPath> <OSInstallationMediaPath>WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso</OSInstallationMediaPath> <InstallationMediaId>sQkdvEXAMPLE</InstallationMediaId> <CustomAvailabilityZoneId>rds-caz-EXAMPLE3</CustomAvailabilityZoneId> <FailureCause/> <Status>Available</Status> </InstallationMedia> </InstallationMedia> </DescribeInstallationMediaResult> <ResponseMetadata> <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId> </ResponseMetadata> </DescribeInstallationMediaResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: