// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Contains the parameters for DescribeReservedInstances.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeReservedInstancesInput {
/// <p>Describes whether the Reserved Instance is Standard or Convertible.</p>
pub offering_class: ::std::option::Option<crate::types::OfferingClassType>,
/// <p>One or more Reserved Instance IDs.</p>
/// <p>Default: Describes all your Reserved Instances, or only those otherwise specified.</p>
pub reserved_instances_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub dry_run: ::std::option::Option<bool>,
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>availability-zone-id</code> - The ID of the Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>duration</code> - The duration of the Reserved Instance (one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</p></li>
/// <li>
/// <p><code>end</code> - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type that is covered by the reservation.</p></li>
/// <li>
/// <p><code>scope</code> - The scope of the Reserved Instance (<code>Region</code> or <code>Availability Zone</code>).</p></li>
/// <li>
/// <p><code>product-description</code> - The Reserved Instance product platform description (<code>Linux/UNIX</code> | <code>Linux with SQL Server Standard</code> | <code>Linux with SQL Server Web</code> | <code>Linux with SQL Server Enterprise</code> | <code>SUSE Linux</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux with HA</code> | <code>Windows</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Web</code> | <code>Windows with SQL Server Enterprise</code>).</p></li>
/// <li>
/// <p><code>reserved-instances-id</code> - The ID of the Reserved Instance.</p></li>
/// <li>
/// <p><code>start</code> - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>state</code> - The state of the Reserved Instance (<code>payment-pending</code> | <code>active</code> | <code>payment-failed</code> | <code>retired</code>).</p></li>
/// <li>
/// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
/// <li>
/// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
/// <li>
/// <p><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</p></li>
/// </ul>
pub filters: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
/// <p>The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the <code>Medium Utilization</code> Reserved Instance offering type.</p>
pub offering_type: ::std::option::Option<crate::types::OfferingTypeValues>,
}
impl DescribeReservedInstancesInput {
/// <p>Describes whether the Reserved Instance is Standard or Convertible.</p>
pub fn offering_class(&self) -> ::std::option::Option<&crate::types::OfferingClassType> {
self.offering_class.as_ref()
}
/// <p>One or more Reserved Instance IDs.</p>
/// <p>Default: Describes all your Reserved Instances, or only those otherwise specified.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.reserved_instances_ids.is_none()`.
pub fn reserved_instances_ids(&self) -> &[::std::string::String] {
self.reserved_instances_ids.as_deref().unwrap_or_default()
}
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn dry_run(&self) -> ::std::option::Option<bool> {
self.dry_run
}
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>availability-zone-id</code> - The ID of the Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>duration</code> - The duration of the Reserved Instance (one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</p></li>
/// <li>
/// <p><code>end</code> - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type that is covered by the reservation.</p></li>
/// <li>
/// <p><code>scope</code> - The scope of the Reserved Instance (<code>Region</code> or <code>Availability Zone</code>).</p></li>
/// <li>
/// <p><code>product-description</code> - The Reserved Instance product platform description (<code>Linux/UNIX</code> | <code>Linux with SQL Server Standard</code> | <code>Linux with SQL Server Web</code> | <code>Linux with SQL Server Enterprise</code> | <code>SUSE Linux</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux with HA</code> | <code>Windows</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Web</code> | <code>Windows with SQL Server Enterprise</code>).</p></li>
/// <li>
/// <p><code>reserved-instances-id</code> - The ID of the Reserved Instance.</p></li>
/// <li>
/// <p><code>start</code> - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>state</code> - The state of the Reserved Instance (<code>payment-pending</code> | <code>active</code> | <code>payment-failed</code> | <code>retired</code>).</p></li>
/// <li>
/// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
/// <li>
/// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
/// <li>
/// <p><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</p></li>
/// </ul>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.filters.is_none()`.
pub fn filters(&self) -> &[crate::types::Filter] {
self.filters.as_deref().unwrap_or_default()
}
/// <p>The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the <code>Medium Utilization</code> Reserved Instance offering type.</p>
pub fn offering_type(&self) -> ::std::option::Option<&crate::types::OfferingTypeValues> {
self.offering_type.as_ref()
}
}
impl DescribeReservedInstancesInput {
/// Creates a new builder-style object to manufacture [`DescribeReservedInstancesInput`](crate::operation::describe_reserved_instances::DescribeReservedInstancesInput).
pub fn builder() -> crate::operation::describe_reserved_instances::builders::DescribeReservedInstancesInputBuilder {
crate::operation::describe_reserved_instances::builders::DescribeReservedInstancesInputBuilder::default()
}
}
/// A builder for [`DescribeReservedInstancesInput`](crate::operation::describe_reserved_instances::DescribeReservedInstancesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeReservedInstancesInputBuilder {
pub(crate) offering_class: ::std::option::Option<crate::types::OfferingClassType>,
pub(crate) reserved_instances_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) dry_run: ::std::option::Option<bool>,
pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>,
pub(crate) offering_type: ::std::option::Option<crate::types::OfferingTypeValues>,
}
impl DescribeReservedInstancesInputBuilder {
/// <p>Describes whether the Reserved Instance is Standard or Convertible.</p>
pub fn offering_class(mut self, input: crate::types::OfferingClassType) -> Self {
self.offering_class = ::std::option::Option::Some(input);
self
}
/// <p>Describes whether the Reserved Instance is Standard or Convertible.</p>
pub fn set_offering_class(mut self, input: ::std::option::Option<crate::types::OfferingClassType>) -> Self {
self.offering_class = input;
self
}
/// <p>Describes whether the Reserved Instance is Standard or Convertible.</p>
pub fn get_offering_class(&self) -> &::std::option::Option<crate::types::OfferingClassType> {
&self.offering_class
}
/// Appends an item to `reserved_instances_ids`.
///
/// To override the contents of this collection use [`set_reserved_instances_ids`](Self::set_reserved_instances_ids).
///
/// <p>One or more Reserved Instance IDs.</p>
/// <p>Default: Describes all your Reserved Instances, or only those otherwise specified.</p>
pub fn reserved_instances_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.reserved_instances_ids.unwrap_or_default();
v.push(input.into());
self.reserved_instances_ids = ::std::option::Option::Some(v);
self
}
/// <p>One or more Reserved Instance IDs.</p>
/// <p>Default: Describes all your Reserved Instances, or only those otherwise specified.</p>
pub fn set_reserved_instances_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.reserved_instances_ids = input;
self
}
/// <p>One or more Reserved Instance IDs.</p>
/// <p>Default: Describes all your Reserved Instances, or only those otherwise specified.</p>
pub fn get_reserved_instances_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.reserved_instances_ids
}
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn dry_run(mut self, input: bool) -> Self {
self.dry_run = ::std::option::Option::Some(input);
self
}
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
self.dry_run = input;
self
}
/// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
&self.dry_run
}
/// Appends an item to `filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>availability-zone-id</code> - The ID of the Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>duration</code> - The duration of the Reserved Instance (one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</p></li>
/// <li>
/// <p><code>end</code> - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type that is covered by the reservation.</p></li>
/// <li>
/// <p><code>scope</code> - The scope of the Reserved Instance (<code>Region</code> or <code>Availability Zone</code>).</p></li>
/// <li>
/// <p><code>product-description</code> - The Reserved Instance product platform description (<code>Linux/UNIX</code> | <code>Linux with SQL Server Standard</code> | <code>Linux with SQL Server Web</code> | <code>Linux with SQL Server Enterprise</code> | <code>SUSE Linux</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux with HA</code> | <code>Windows</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Web</code> | <code>Windows with SQL Server Enterprise</code>).</p></li>
/// <li>
/// <p><code>reserved-instances-id</code> - The ID of the Reserved Instance.</p></li>
/// <li>
/// <p><code>start</code> - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>state</code> - The state of the Reserved Instance (<code>payment-pending</code> | <code>active</code> | <code>payment-failed</code> | <code>retired</code>).</p></li>
/// <li>
/// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
/// <li>
/// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
/// <li>
/// <p><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</p></li>
/// </ul>
pub fn filters(mut self, input: crate::types::Filter) -> Self {
let mut v = self.filters.unwrap_or_default();
v.push(input);
self.filters = ::std::option::Option::Some(v);
self
}
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>availability-zone-id</code> - The ID of the Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>duration</code> - The duration of the Reserved Instance (one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</p></li>
/// <li>
/// <p><code>end</code> - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type that is covered by the reservation.</p></li>
/// <li>
/// <p><code>scope</code> - The scope of the Reserved Instance (<code>Region</code> or <code>Availability Zone</code>).</p></li>
/// <li>
/// <p><code>product-description</code> - The Reserved Instance product platform description (<code>Linux/UNIX</code> | <code>Linux with SQL Server Standard</code> | <code>Linux with SQL Server Web</code> | <code>Linux with SQL Server Enterprise</code> | <code>SUSE Linux</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux with HA</code> | <code>Windows</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Web</code> | <code>Windows with SQL Server Enterprise</code>).</p></li>
/// <li>
/// <p><code>reserved-instances-id</code> - The ID of the Reserved Instance.</p></li>
/// <li>
/// <p><code>start</code> - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>state</code> - The state of the Reserved Instance (<code>payment-pending</code> | <code>active</code> | <code>payment-failed</code> | <code>retired</code>).</p></li>
/// <li>
/// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
/// <li>
/// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
/// <li>
/// <p><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</p></li>
/// </ul>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
self.filters = input;
self
}
/// <p>One or more filters.</p>
/// <ul>
/// <li>
/// <p><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>availability-zone-id</code> - The ID of the Availability Zone where the Reserved Instance can be used.</p></li>
/// <li>
/// <p><code>duration</code> - The duration of the Reserved Instance (one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</p></li>
/// <li>
/// <p><code>end</code> - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</p></li>
/// <li>
/// <p><code>instance-type</code> - The instance type that is covered by the reservation.</p></li>
/// <li>
/// <p><code>scope</code> - The scope of the Reserved Instance (<code>Region</code> or <code>Availability Zone</code>).</p></li>
/// <li>
/// <p><code>product-description</code> - The Reserved Instance product platform description (<code>Linux/UNIX</code> | <code>Linux with SQL Server Standard</code> | <code>Linux with SQL Server Web</code> | <code>Linux with SQL Server Enterprise</code> | <code>SUSE Linux</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux with HA</code> | <code>Windows</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Web</code> | <code>Windows with SQL Server Enterprise</code>).</p></li>
/// <li>
/// <p><code>reserved-instances-id</code> - The ID of the Reserved Instance.</p></li>
/// <li>
/// <p><code>start</code> - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).</p></li>
/// <li>
/// <p><code>state</code> - The state of the Reserved Instance (<code>payment-pending</code> | <code>active</code> | <code>payment-failed</code> | <code>retired</code>).</p></li>
/// <li>
/// <p><code>tag:<key></key></code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
/// <li>
/// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
/// <li>
/// <p><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</p></li>
/// </ul>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
&self.filters
}
/// <p>The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the <code>Medium Utilization</code> Reserved Instance offering type.</p>
pub fn offering_type(mut self, input: crate::types::OfferingTypeValues) -> Self {
self.offering_type = ::std::option::Option::Some(input);
self
}
/// <p>The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the <code>Medium Utilization</code> Reserved Instance offering type.</p>
pub fn set_offering_type(mut self, input: ::std::option::Option<crate::types::OfferingTypeValues>) -> Self {
self.offering_type = input;
self
}
/// <p>The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the <code>Medium Utilization</code> Reserved Instance offering type.</p>
pub fn get_offering_type(&self) -> &::std::option::Option<crate::types::OfferingTypeValues> {
&self.offering_type
}
/// Consumes the builder and constructs a [`DescribeReservedInstancesInput`](crate::operation::describe_reserved_instances::DescribeReservedInstancesInput).
pub fn build(
self,
) -> ::std::result::Result<
crate::operation::describe_reserved_instances::DescribeReservedInstancesInput,
::aws_smithy_types::error::operation::BuildError,
> {
::std::result::Result::Ok(crate::operation::describe_reserved_instances::DescribeReservedInstancesInput {
offering_class: self.offering_class,
reserved_instances_ids: self.reserved_instances_ids,
dry_run: self.dry_run,
filters: self.filters,
offering_type: self.offering_type,
})
}
}