aws_sdk_cleanrooms/client/
create_membership.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 [`CreateMembership`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`collaboration_identifier(impl Into<String>)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::collaboration_identifier) / [`set_collaboration_identifier(Option<String>)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::set_collaboration_identifier):<br>required: **true**<br><p>The unique ID for the associated collaboration.</p><br>
7    ///   - [`query_log_status(MembershipQueryLogStatus)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::query_log_status) / [`set_query_log_status(Option<MembershipQueryLogStatus>)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::set_query_log_status):<br>required: **true**<br><p>An indicator as to whether query logging has been enabled or disabled for the membership.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p><br>
8    ///   - [`job_log_status(MembershipJobLogStatus)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::job_log_status) / [`set_job_log_status(Option<MembershipJobLogStatus>)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::set_job_log_status):<br>required: **false**<br><p>An indicator as to whether job logging has been enabled or disabled for the collaboration.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p><br>
9    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::set_tags):<br>required: **false**<br><p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p><br>
10    ///   - [`default_result_configuration(MembershipProtectedQueryResultConfiguration)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::default_result_configuration) / [`set_default_result_configuration(Option<MembershipProtectedQueryResultConfiguration>)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::set_default_result_configuration):<br>required: **false**<br><p>The default protected query result configuration as specified by the member who can receive results.</p><br>
11    ///   - [`default_job_result_configuration(MembershipProtectedJobResultConfiguration)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::default_job_result_configuration) / [`set_default_job_result_configuration(Option<MembershipProtectedJobResultConfiguration>)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::set_default_job_result_configuration):<br>required: **false**<br><p>The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.</p><br>
12    ///   - [`payment_configuration(MembershipPaymentConfiguration)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::payment_configuration) / [`set_payment_configuration(Option<MembershipPaymentConfiguration>)`](crate::operation::create_membership::builders::CreateMembershipFluentBuilder::set_payment_configuration):<br>required: **false**<br><p>The payment responsibilities accepted by the collaboration member.</p> <p>Not required if the collaboration member has the member ability to run queries.</p> <p>Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.</p><br>
13    /// - On success, responds with [`CreateMembershipOutput`](crate::operation::create_membership::CreateMembershipOutput) with field(s):
14    ///   - [`membership(Option<Membership>)`](crate::operation::create_membership::CreateMembershipOutput::membership): <p>The membership that was created.</p>
15    /// - On failure, responds with [`SdkError<CreateMembershipError>`](crate::operation::create_membership::CreateMembershipError)
16    pub fn create_membership(&self) -> crate::operation::create_membership::builders::CreateMembershipFluentBuilder {
17        crate::operation::create_membership::builders::CreateMembershipFluentBuilder::new(self.handle.clone())
18    }
19}