aws_sdk_ssoadmin/client/
describe_application_assignment.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 [`DescribeApplicationAssignment`](crate::operation::describe_application_assignment::builders::DescribeApplicationAssignmentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_arn(impl Into<String>)`](crate::operation::describe_application_assignment::builders::DescribeApplicationAssignmentFluentBuilder::application_arn) / [`set_application_arn(Option<String>)`](crate::operation::describe_application_assignment::builders::DescribeApplicationAssignmentFluentBuilder::set_application_arn):<br>required: **true**<br><p>Specifies the ARN of the application. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p><br>
7    ///   - [`principal_id(impl Into<String>)`](crate::operation::describe_application_assignment::builders::DescribeApplicationAssignmentFluentBuilder::principal_id) / [`set_principal_id(Option<String>)`](crate::operation::describe_application_assignment::builders::DescribeApplicationAssignmentFluentBuilder::set_principal_id):<br>required: **true**<br><p>An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.</p><br>
8    ///   - [`principal_type(PrincipalType)`](crate::operation::describe_application_assignment::builders::DescribeApplicationAssignmentFluentBuilder::principal_type) / [`set_principal_type(Option<PrincipalType>)`](crate::operation::describe_application_assignment::builders::DescribeApplicationAssignmentFluentBuilder::set_principal_type):<br>required: **true**<br><p>The entity type for which the assignment will be created.</p><br>
9    /// - On success, responds with [`DescribeApplicationAssignmentOutput`](crate::operation::describe_application_assignment::DescribeApplicationAssignmentOutput) with field(s):
10    ///   - [`principal_type(Option<PrincipalType>)`](crate::operation::describe_application_assignment::DescribeApplicationAssignmentOutput::principal_type): <p>The entity type for which the assignment will be created.</p>
11    ///   - [`principal_id(Option<String>)`](crate::operation::describe_application_assignment::DescribeApplicationAssignmentOutput::principal_id): <p>An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.</p>
12    ///   - [`application_arn(Option<String>)`](crate::operation::describe_application_assignment::DescribeApplicationAssignmentOutput::application_arn): <p>Specifies the ARN of the application. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
13    /// - On failure, responds with [`SdkError<DescribeApplicationAssignmentError>`](crate::operation::describe_application_assignment::DescribeApplicationAssignmentError)
14    pub fn describe_application_assignment(
15        &self,
16    ) -> crate::operation::describe_application_assignment::builders::DescribeApplicationAssignmentFluentBuilder {
17        crate::operation::describe_application_assignment::builders::DescribeApplicationAssignmentFluentBuilder::new(self.handle.clone())
18    }
19}