aws_sdk_iotsitewise/client/
describe_project.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 [`DescribeProject`](crate::operation::describe_project::builders::DescribeProjectFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`project_id(impl Into<String>)`](crate::operation::describe_project::builders::DescribeProjectFluentBuilder::project_id) / [`set_project_id(Option<String>)`](crate::operation::describe_project::builders::DescribeProjectFluentBuilder::set_project_id):<br>required: **true**<br><p>The ID of the project.</p><br>
7    /// - On success, responds with [`DescribeProjectOutput`](crate::operation::describe_project::DescribeProjectOutput) with field(s):
8    ///   - [`project_id(String)`](crate::operation::describe_project::DescribeProjectOutput::project_id): <p>The ID of the project.</p>
9    ///   - [`project_arn(String)`](crate::operation::describe_project::DescribeProjectOutput::project_arn): <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the project, which has the following format.</p> <p><code>arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}</code></p>
10    ///   - [`project_name(String)`](crate::operation::describe_project::DescribeProjectOutput::project_name): <p>The name of the project.</p>
11    ///   - [`portal_id(String)`](crate::operation::describe_project::DescribeProjectOutput::portal_id): <p>The ID of the portal that the project is in.</p>
12    ///   - [`project_description(Option<String>)`](crate::operation::describe_project::DescribeProjectOutput::project_description): <p>The project's description.</p>
13    ///   - [`project_creation_date(DateTime)`](crate::operation::describe_project::DescribeProjectOutput::project_creation_date): <p>The date the project was created, in Unix epoch time.</p>
14    ///   - [`project_last_update_date(DateTime)`](crate::operation::describe_project::DescribeProjectOutput::project_last_update_date): <p>The date the project was last updated, in Unix epoch time.</p>
15    /// - On failure, responds with [`SdkError<DescribeProjectError>`](crate::operation::describe_project::DescribeProjectError)
16    pub fn describe_project(&self) -> crate::operation::describe_project::builders::DescribeProjectFluentBuilder {
17        crate::operation::describe_project::builders::DescribeProjectFluentBuilder::new(self.handle.clone())
18    }
19}