aws_sdk_securityhub/client/describe_products.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`DescribeProducts`](crate::operation::describe_products::builders::DescribeProductsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_products::builders::DescribeProductsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`next_token(impl Into<String>)`](crate::operation::describe_products::builders::DescribeProductsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_products::builders::DescribeProductsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token that is required for pagination. On your first call to the <code>DescribeProducts</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p><br>
8 /// - [`max_results(i32)`](crate::operation::describe_products::builders::DescribeProductsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_products::builders::DescribeProductsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
9 /// - [`product_arn(impl Into<String>)`](crate::operation::describe_products::builders::DescribeProductsFluentBuilder::product_arn) / [`set_product_arn(Option<String>)`](crate::operation::describe_products::builders::DescribeProductsFluentBuilder::set_product_arn):<br>required: **false**<br><p>The ARN of the integration to return.</p><br>
10 /// - On success, responds with [`DescribeProductsOutput`](crate::operation::describe_products::DescribeProductsOutput) with field(s):
11 /// - [`products(Option<Vec::<Product>>)`](crate::operation::describe_products::DescribeProductsOutput::products): <p>A list of products, including details for each product.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::describe_products::DescribeProductsOutput::next_token): <p>The pagination token to use to request the next page of results.</p>
13 /// - On failure, responds with [`SdkError<DescribeProductsError>`](crate::operation::describe_products::DescribeProductsError)
14 pub fn describe_products(&self) -> crate::operation::describe_products::builders::DescribeProductsFluentBuilder {
15 crate::operation::describe_products::builders::DescribeProductsFluentBuilder::new(self.handle.clone())
16 }
17}