1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateParticipantToken`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`stage_arn(impl Into<String>)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::stage_arn) / [`set_stage_arn(Option<String>)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::set_stage_arn):<br>required: **true**<br><p>ARN of the stage to which this token is scoped.</p><br>
    ///   - [`duration(i32)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::duration) / [`set_duration(Option<i32>)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::set_duration):<br>required: **false**<br><p>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</p><br>
    ///   - [`user_id(impl Into<String>)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::set_user_id):<br>required: **false**<br><p>Name that can be specified to help identify the token. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p><br>
    ///   - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::set_attributes):<br>required: **false**<br><p>Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p><br>
    ///   - [`capabilities(ParticipantTokenCapability)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::capabilities) / [`set_capabilities(Option<Vec::<ParticipantTokenCapability>>)`](crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::set_capabilities):<br>required: **false**<br><p>Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.</p><br>
    /// - On success, responds with [`CreateParticipantTokenOutput`](crate::operation::create_participant_token::CreateParticipantTokenOutput) with field(s):
    ///   - [`participant_token(Option<ParticipantToken>)`](crate::operation::create_participant_token::CreateParticipantTokenOutput::participant_token): <p>The participant token that was created.</p>
    /// - On failure, responds with [`SdkError<CreateParticipantTokenError>`](crate::operation::create_participant_token::CreateParticipantTokenError)
    pub fn create_participant_token(&self) -> crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder {
        crate::operation::create_participant_token::builders::CreateParticipantTokenFluentBuilder::new(self.handle.clone())
    }
}