Skip to main content

aws_sdk_iam/client/
acquire_role.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 [`AcquireRole`](crate::operation::acquire_role::builders::AcquireRoleFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`template_arn(impl Into<String>)`](crate::operation::acquire_role::builders::AcquireRoleFluentBuilder::template_arn) / [`set_template_arn(Option<String>)`](crate::operation::acquire_role::builders::AcquireRoleFluentBuilder::set_template_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the role template to create the role from.</p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p><br>
7    ///   - [`template_minor_version(i32)`](crate::operation::acquire_role::builders::AcquireRoleFluentBuilder::template_minor_version) / [`set_template_minor_version(Option<i32>)`](crate::operation::acquire_role::builders::AcquireRoleFluentBuilder::set_template_minor_version):<br>required: **false**<br><p>The minor version of the role template to use. If you do not specify a minor version, the service uses the template's default minor version.</p><br>
8    ///   - [`replacement_values(impl Into<String>, ReplacementValueEntry)`](crate::operation::acquire_role::builders::AcquireRoleFluentBuilder::replacement_values) / [`set_replacement_values(Option<HashMap::<String, ReplacementValueEntry>>)`](crate::operation::acquire_role::builders::AcquireRoleFluentBuilder::set_replacement_values):<br>required: **false**<br><p>A map of values to substitute for the parameters that are defined in the role template version. Each key is a parameter name from the template, and each value is a structure that contains the replacement values for that parameter.</p><br>
9    /// - On success, responds with [`AcquireRoleOutput`](crate::operation::acquire_role::AcquireRoleOutput) with field(s):
10    ///   - [`role(Option<Role>)`](crate::operation::acquire_role::AcquireRoleOutput::role): <p>A structure that contains details about the IAM role that was created.</p>
11    /// - On failure, responds with [`SdkError<AcquireRoleError>`](crate::operation::acquire_role::AcquireRoleError)
12    pub fn acquire_role(&self) -> crate::operation::acquire_role::builders::AcquireRoleFluentBuilder {
13        crate::operation::acquire_role::builders::AcquireRoleFluentBuilder::new(self.handle.clone())
14    }
15}