/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace EC2 { namespace Model { /** */ class DescribeFpgaImagesRequest : public EC2Request { public: AWS_EC2_API DescribeFpgaImagesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeFpgaImages"; } AWS_EC2_API Aws::String SerializePayload() const override; protected: AWS_EC2_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

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 DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline bool GetDryRun() const{ return m_dryRun; } /** *

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 DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; } /** *

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 DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; } /** *

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 DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline DescribeFpgaImagesRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

The AFI IDs.

*/ inline const Aws::Vector& GetFpgaImageIds() const{ return m_fpgaImageIds; } /** *

The AFI IDs.

*/ inline bool FpgaImageIdsHasBeenSet() const { return m_fpgaImageIdsHasBeenSet; } /** *

The AFI IDs.

*/ inline void SetFpgaImageIds(const Aws::Vector& value) { m_fpgaImageIdsHasBeenSet = true; m_fpgaImageIds = value; } /** *

The AFI IDs.

*/ inline void SetFpgaImageIds(Aws::Vector&& value) { m_fpgaImageIdsHasBeenSet = true; m_fpgaImageIds = std::move(value); } /** *

The AFI IDs.

*/ inline DescribeFpgaImagesRequest& WithFpgaImageIds(const Aws::Vector& value) { SetFpgaImageIds(value); return *this;} /** *

The AFI IDs.

*/ inline DescribeFpgaImagesRequest& WithFpgaImageIds(Aws::Vector&& value) { SetFpgaImageIds(std::move(value)); return *this;} /** *

The AFI IDs.

*/ inline DescribeFpgaImagesRequest& AddFpgaImageIds(const Aws::String& value) { m_fpgaImageIdsHasBeenSet = true; m_fpgaImageIds.push_back(value); return *this; } /** *

The AFI IDs.

*/ inline DescribeFpgaImagesRequest& AddFpgaImageIds(Aws::String&& value) { m_fpgaImageIdsHasBeenSet = true; m_fpgaImageIds.push_back(std::move(value)); return *this; } /** *

The AFI IDs.

*/ inline DescribeFpgaImagesRequest& AddFpgaImageIds(const char* value) { m_fpgaImageIdsHasBeenSet = true; m_fpgaImageIds.push_back(value); return *this; } /** *

Filters the AFI by owner. Specify an Amazon Web Services account ID, * self (owner is the sender of the request), or an Amazon Web * Services owner alias (valid values are amazon | * aws-marketplace).

*/ inline const Aws::Vector& GetOwners() const{ return m_owners; } /** *

Filters the AFI by owner. Specify an Amazon Web Services account ID, * self (owner is the sender of the request), or an Amazon Web * Services owner alias (valid values are amazon | * aws-marketplace).

*/ inline bool OwnersHasBeenSet() const { return m_ownersHasBeenSet; } /** *

Filters the AFI by owner. Specify an Amazon Web Services account ID, * self (owner is the sender of the request), or an Amazon Web * Services owner alias (valid values are amazon | * aws-marketplace).

*/ inline void SetOwners(const Aws::Vector& value) { m_ownersHasBeenSet = true; m_owners = value; } /** *

Filters the AFI by owner. Specify an Amazon Web Services account ID, * self (owner is the sender of the request), or an Amazon Web * Services owner alias (valid values are amazon | * aws-marketplace).

*/ inline void SetOwners(Aws::Vector&& value) { m_ownersHasBeenSet = true; m_owners = std::move(value); } /** *

Filters the AFI by owner. Specify an Amazon Web Services account ID, * self (owner is the sender of the request), or an Amazon Web * Services owner alias (valid values are amazon | * aws-marketplace).

*/ inline DescribeFpgaImagesRequest& WithOwners(const Aws::Vector& value) { SetOwners(value); return *this;} /** *

Filters the AFI by owner. Specify an Amazon Web Services account ID, * self (owner is the sender of the request), or an Amazon Web * Services owner alias (valid values are amazon | * aws-marketplace).

*/ inline DescribeFpgaImagesRequest& WithOwners(Aws::Vector&& value) { SetOwners(std::move(value)); return *this;} /** *

Filters the AFI by owner. Specify an Amazon Web Services account ID, * self (owner is the sender of the request), or an Amazon Web * Services owner alias (valid values are amazon | * aws-marketplace).

*/ inline DescribeFpgaImagesRequest& AddOwners(const Aws::String& value) { m_ownersHasBeenSet = true; m_owners.push_back(value); return *this; } /** *

Filters the AFI by owner. Specify an Amazon Web Services account ID, * self (owner is the sender of the request), or an Amazon Web * Services owner alias (valid values are amazon | * aws-marketplace).

*/ inline DescribeFpgaImagesRequest& AddOwners(Aws::String&& value) { m_ownersHasBeenSet = true; m_owners.push_back(std::move(value)); return *this; } /** *

Filters the AFI by owner. Specify an Amazon Web Services account ID, * self (owner is the sender of the request), or an Amazon Web * Services owner alias (valid values are amazon | * aws-marketplace).

*/ inline DescribeFpgaImagesRequest& AddOwners(const char* value) { m_ownersHasBeenSet = true; m_owners.push_back(value); return *this; } /** *

The filters.

  • create-time - The creation time * of the AFI.

  • fpga-image-id - The FPGA image * identifier (AFI ID).

  • fpga-image-global-id - The * global FPGA image identifier (AGFI ID).

  • name - * The name of the AFI.

  • owner-id - The Amazon Web * Services account ID of the AFI owner.

  • * product-code - The product code.

  • * shell-version - The version of the Amazon Web Services Shell that * was used to create the bitstream.

  • state - The * state of the AFI (pending | failed | * available | unavailable).

  • * tag:<key> - 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 * Owner and the value TeamA, specify * tag:Owner for the filter name and TeamA for the filter * value.

  • tag-key - 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.

  • * update-time - The time of the most recent update.

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

The filters.

  • create-time - The creation time * of the AFI.

  • fpga-image-id - The FPGA image * identifier (AFI ID).

  • fpga-image-global-id - The * global FPGA image identifier (AGFI ID).

  • name - * The name of the AFI.

  • owner-id - The Amazon Web * Services account ID of the AFI owner.

  • * product-code - The product code.

  • * shell-version - The version of the Amazon Web Services Shell that * was used to create the bitstream.

  • state - The * state of the AFI (pending | failed | * available | unavailable).

  • * tag:<key> - 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 * Owner and the value TeamA, specify * tag:Owner for the filter name and TeamA for the filter * value.

  • tag-key - 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.

  • * update-time - The time of the most recent update.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

The filters.

  • create-time - The creation time * of the AFI.

  • fpga-image-id - The FPGA image * identifier (AFI ID).

  • fpga-image-global-id - The * global FPGA image identifier (AGFI ID).

  • name - * The name of the AFI.

  • owner-id - The Amazon Web * Services account ID of the AFI owner.

  • * product-code - The product code.

  • * shell-version - The version of the Amazon Web Services Shell that * was used to create the bitstream.

  • state - The * state of the AFI (pending | failed | * available | unavailable).

  • * tag:<key> - 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 * Owner and the value TeamA, specify * tag:Owner for the filter name and TeamA for the filter * value.

  • tag-key - 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.

  • * update-time - The time of the most recent update.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

The filters.

  • create-time - The creation time * of the AFI.

  • fpga-image-id - The FPGA image * identifier (AFI ID).

  • fpga-image-global-id - The * global FPGA image identifier (AGFI ID).

  • name - * The name of the AFI.

  • owner-id - The Amazon Web * Services account ID of the AFI owner.

  • * product-code - The product code.

  • * shell-version - The version of the Amazon Web Services Shell that * was used to create the bitstream.

  • state - The * state of the AFI (pending | failed | * available | unavailable).

  • * tag:<key> - 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 * Owner and the value TeamA, specify * tag:Owner for the filter name and TeamA for the filter * value.

  • tag-key - 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.

  • * update-time - The time of the most recent update.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

The filters.

  • create-time - The creation time * of the AFI.

  • fpga-image-id - The FPGA image * identifier (AFI ID).

  • fpga-image-global-id - The * global FPGA image identifier (AGFI ID).

  • name - * The name of the AFI.

  • owner-id - The Amazon Web * Services account ID of the AFI owner.

  • * product-code - The product code.

  • * shell-version - The version of the Amazon Web Services Shell that * was used to create the bitstream.

  • state - The * state of the AFI (pending | failed | * available | unavailable).

  • * tag:<key> - 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 * Owner and the value TeamA, specify * tag:Owner for the filter name and TeamA for the filter * value.

  • tag-key - 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.

  • * update-time - The time of the most recent update.

*/ inline DescribeFpgaImagesRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

The filters.

  • create-time - The creation time * of the AFI.

  • fpga-image-id - The FPGA image * identifier (AFI ID).

  • fpga-image-global-id - The * global FPGA image identifier (AGFI ID).

  • name - * The name of the AFI.

  • owner-id - The Amazon Web * Services account ID of the AFI owner.

  • * product-code - The product code.

  • * shell-version - The version of the Amazon Web Services Shell that * was used to create the bitstream.

  • state - The * state of the AFI (pending | failed | * available | unavailable).

  • * tag:<key> - 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 * Owner and the value TeamA, specify * tag:Owner for the filter name and TeamA for the filter * value.

  • tag-key - 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.

  • * update-time - The time of the most recent update.

*/ inline DescribeFpgaImagesRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

The filters.

  • create-time - The creation time * of the AFI.

  • fpga-image-id - The FPGA image * identifier (AFI ID).

  • fpga-image-global-id - The * global FPGA image identifier (AGFI ID).

  • name - * The name of the AFI.

  • owner-id - The Amazon Web * Services account ID of the AFI owner.

  • * product-code - The product code.

  • * shell-version - The version of the Amazon Web Services Shell that * was used to create the bitstream.

  • state - The * state of the AFI (pending | failed | * available | unavailable).

  • * tag:<key> - 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 * Owner and the value TeamA, specify * tag:Owner for the filter name and TeamA for the filter * value.

  • tag-key - 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.

  • * update-time - The time of the most recent update.

*/ inline DescribeFpgaImagesRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

The filters.

  • create-time - The creation time * of the AFI.

  • fpga-image-id - The FPGA image * identifier (AFI ID).

  • fpga-image-global-id - The * global FPGA image identifier (AGFI ID).

  • name - * The name of the AFI.

  • owner-id - The Amazon Web * Services account ID of the AFI owner.

  • * product-code - The product code.

  • * shell-version - The version of the Amazon Web Services Shell that * was used to create the bitstream.

  • state - The * state of the AFI (pending | failed | * available | unavailable).

  • * tag:<key> - 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 * Owner and the value TeamA, specify * tag:Owner for the filter name and TeamA for the filter * value.

  • tag-key - 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.

  • * update-time - The time of the most recent update.

*/ inline DescribeFpgaImagesRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

The token to retrieve the next page of results.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

The token to retrieve the next page of results.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

The token to retrieve the next page of results.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

The token to retrieve the next page of results.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

The token to retrieve the next page of results.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

The token to retrieve the next page of results.

*/ inline DescribeFpgaImagesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

The token to retrieve the next page of results.

*/ inline DescribeFpgaImagesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

The token to retrieve the next page of results.

*/ inline DescribeFpgaImagesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The maximum number of results to return in a single call.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of results to return in a single call.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of results to return in a single call.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of results to return in a single call.

*/ inline DescribeFpgaImagesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} private: bool m_dryRun; bool m_dryRunHasBeenSet = false; Aws::Vector m_fpgaImageIds; bool m_fpgaImageIdsHasBeenSet = false; Aws::Vector m_owners; bool m_ownersHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws