pub struct Client { /* private fields */ }
Expand description
Client for AWS Clean Rooms Service
Client for invoking operations on AWS Clean Rooms Service. Each operation on AWS Clean Rooms Service is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_cleanrooms::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_cleanrooms::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the BatchGetCollaborationAnalysisTemplate
operation has
a Client::batch_get_collaboration_analysis_template
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.batch_get_collaboration_analysis_template()
.collaboration_identifier("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn batch_get_collaboration_analysis_template(
&self,
) -> BatchGetCollaborationAnalysisTemplateFluentBuilder
pub fn batch_get_collaboration_analysis_template( &self, ) -> BatchGetCollaborationAnalysisTemplateFluentBuilder
Constructs a fluent builder for the BatchGetCollaborationAnalysisTemplate
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
analysis_template_arns(impl Into<String>)
/set_analysis_template_arns(Option<Vec::<String>>)
:
required: trueThe Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
- On success, responds with
BatchGetCollaborationAnalysisTemplateOutput
with field(s):collaboration_analysis_templates(Vec::<CollaborationAnalysisTemplate>)
:The retrieved list of analysis templates within a collaboration.
errors(Vec::<BatchGetCollaborationAnalysisTemplateError>)
:Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.
- On failure, responds with
SdkError<BatchGetCollaborationAnalysisTemplateError>
Source§impl Client
impl Client
Sourcepub fn batch_get_schema(&self) -> BatchGetSchemaFluentBuilder
pub fn batch_get_schema(&self) -> BatchGetSchemaFluentBuilder
Constructs a fluent builder for the BatchGetSchema
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.
names(impl Into<String>)
/set_names(Option<Vec::<String>>)
:
required: trueThe names for the schema objects to retrieve.
- On success, responds with
BatchGetSchemaOutput
with field(s):schemas(Vec::<Schema>)
:The retrieved list of schemas.
errors(Vec::<BatchGetSchemaError>)
:Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
- On failure, responds with
SdkError<BatchGetSchemaError>
Source§impl Client
impl Client
Sourcepub fn batch_get_schema_analysis_rule(
&self,
) -> BatchGetSchemaAnalysisRuleFluentBuilder
pub fn batch_get_schema_analysis_rule( &self, ) -> BatchGetSchemaAnalysisRuleFluentBuilder
Constructs a fluent builder for the BatchGetSchemaAnalysisRule
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe unique identifier of the collaboration that contains the schema analysis rule.
schema_analysis_rule_requests(SchemaAnalysisRuleRequest)
/set_schema_analysis_rule_requests(Option<Vec::<SchemaAnalysisRuleRequest>>)
:
required: trueThe information that’s necessary to retrieve a schema analysis rule.
- On success, responds with
BatchGetSchemaAnalysisRuleOutput
with field(s):analysis_rules(Vec::<AnalysisRule>)
:The retrieved list of analysis rules.
errors(Vec::<BatchGetSchemaAnalysisRuleError>)
:Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
- On failure, responds with
SdkError<BatchGetSchemaAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn create_analysis_template(&self) -> CreateAnalysisTemplateFluentBuilder
pub fn create_analysis_template(&self) -> CreateAnalysisTemplateFluentBuilder
Constructs a fluent builder for the CreateAnalysisTemplate
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the analysis template.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a membership resource.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the analysis template.
format(AnalysisFormat)
/set_format(Option<AnalysisFormat>)
:
required: trueThe format of the analysis template.
source(AnalysisSource)
/set_source(Option<AnalysisSource>)
:
required: trueThe information in the analysis template.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn 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.
analysis_parameters(AnalysisParameter)
/set_analysis_parameters(Option<Vec::<AnalysisParameter>>)
:
required: falseThe parameters of the analysis template.
schema(AnalysisSchema)
/set_schema(Option<AnalysisSchema>)
:
required: falseA relation within an analysis.
error_message_configuration(ErrorMessageConfiguration)
/set_error_message_configuration(Option<ErrorMessageConfiguration>)
:
required: falseThe configuration that specifies the level of detail in error messages returned by analyses using this template. When set to
DETAILED
, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.
- On success, responds with
CreateAnalysisTemplateOutput
with field(s):analysis_template(Option<AnalysisTemplate>)
:The analysis template.
- On failure, responds with
SdkError<CreateAnalysisTemplateError>
Source§impl Client
impl Client
Sourcepub fn create_collaboration(&self) -> CreateCollaborationFluentBuilder
pub fn create_collaboration(&self) -> CreateCollaborationFluentBuilder
Constructs a fluent builder for the CreateCollaboration
operation.
- The fluent builder is configurable:
members(MemberSpecification)
/set_members(Option<Vec::<MemberSpecification>>)
:
required: trueA list of initial members, not including the creator. This list is immutable.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe display name for a collaboration.
description(impl Into<String>)
/set_description(Option<String>)
:
required: trueA description of the collaboration provided by the collaboration owner.
creator_member_abilities(MemberAbility)
/set_creator_member_abilities(Option<Vec::<MemberAbility>>)
:
required: trueThe abilities granted to the collaboration creator.
creator_ml_member_abilities(MlMemberAbilities)
/set_creator_ml_member_abilities(Option<MlMemberAbilities>)
:
required: falseThe ML abilities granted to the collaboration creator.
creator_display_name(impl Into<String>)
/set_creator_display_name(Option<String>)
:
required: trueThe display name of the collaboration creator.
data_encryption_metadata(DataEncryptionMetadata)
/set_data_encryption_metadata(Option<DataEncryptionMetadata>)
:
required: falseThe settings for client-side encryption with Cryptographic Computing for Clean Rooms.
query_log_status(CollaborationQueryLogStatus)
/set_query_log_status(Option<CollaborationQueryLogStatus>)
:
required: trueAn indicator as to whether query logging has been enabled or disabled for the collaboration.
When
ENABLED
, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value isDISABLED
.job_log_status(CollaborationJobLogStatus)
/set_job_log_status(Option<CollaborationJobLogStatus>)
:
required: falseSpecifies whether job logs are enabled for this collaboration.
When
ENABLED
, Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value isDISABLED
.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn 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.
creator_payment_configuration(PaymentConfiguration)
/set_creator_payment_configuration(Option<PaymentConfiguration>)
:
required: falseThe collaboration creator’s payment responsibilities set by the collaboration creator.
If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
analytics_engine(AnalyticsEngine)
/set_analytics_engine(Option<AnalyticsEngine>)
:
required: falseThe analytics engine.
After July 16, 2025, the
CLEAN_ROOMS_SQL
parameter will no longer be available.auto_approved_change_request_types(AutoApprovedChangeType)
/set_auto_approved_change_request_types(Option<Vec::<AutoApprovedChangeType>>)
:
required: falseThe types of change requests that are automatically approved for this collaboration.
- On success, responds with
CreateCollaborationOutput
with field(s):collaboration(Option<Collaboration>)
:The collaboration.
- On failure, responds with
SdkError<CreateCollaborationError>
Source§impl Client
impl Client
Sourcepub fn create_collaboration_change_request(
&self,
) -> CreateCollaborationChangeRequestFluentBuilder
pub fn create_collaboration_change_request( &self, ) -> CreateCollaborationChangeRequestFluentBuilder
Constructs a fluent builder for the CreateCollaborationChangeRequest
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe identifier of the collaboration that the change request is made against.
changes(ChangeInput)
/set_changes(Option<Vec::<ChangeInput>>)
:
required: trueThe list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed.
- On success, responds with
CreateCollaborationChangeRequestOutput
with field(s):collaboration_change_request(Option<CollaborationChangeRequest>)
:Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.
- On failure, responds with
SdkError<CreateCollaborationChangeRequestError>
Source§impl Client
impl Client
Sourcepub fn create_configured_audience_model_association(
&self,
) -> CreateConfiguredAudienceModelAssociationFluentBuilder
pub fn create_configured_audience_model_association( &self, ) -> CreateConfiguredAudienceModelAssociationFluentBuilder
Constructs a fluent builder for the CreateConfiguredAudienceModelAssociation
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.
configured_audience_model_arn(impl Into<String>)
/set_configured_audience_model_arn(Option<String>)
:
required: trueA unique identifier for the configured audience model that you want to associate.
configured_audience_model_association_name(impl Into<String>)
/set_configured_audience_model_association_name(Option<String>)
:
required: trueThe name of the configured audience model association.
manage_resource_policies(bool)
/set_manage_resource_policies(Option<bool>)
:
required: trueWhen
TRUE
, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. WhenFALSE
, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.Setting this to
TRUE
requires you to have permissions to create, update, and delete the resource policy for thecleanrooms-ml
resource when you call theDeleteConfiguredAudienceModelAssociation
resource. In addition, if you are the collaboration creator and specifyTRUE
, you must have the same permissions when you call theDeleteMember
andDeleteCollaboration
APIs.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn 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.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the configured audience model association.
- On success, responds with
CreateConfiguredAudienceModelAssociationOutput
with field(s):configured_audience_model_association(Option<ConfiguredAudienceModelAssociation>)
:Information about the configured audience model association.
- On failure, responds with
SdkError<CreateConfiguredAudienceModelAssociationError>
Source§impl Client
impl Client
Sourcepub fn create_configured_table(&self) -> CreateConfiguredTableFluentBuilder
pub fn create_configured_table(&self) -> CreateConfiguredTableFluentBuilder
Constructs a fluent builder for the CreateConfiguredTable
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the configured table.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the configured table.
table_reference(TableReference)
/set_table_reference(Option<TableReference>)
:
required: trueA reference to the table being configured.
allowed_columns(impl Into<String>)
/set_allowed_columns(Option<Vec::<String>>)
:
required: trueThe columns of the underlying table that can be used by collaborations or analysis rules.
analysis_method(AnalysisMethod)
/set_analysis_method(Option<AnalysisMethod>)
:
required: trueThe analysis method allowed for the configured tables.
DIRECT_QUERY
allows SQL queries to be run directly on this table.DIRECT_JOB
allows PySpark jobs to be run directly on this table.MULTIPLE
allows both SQL queries and PySpark jobs to be run directly on this table.selected_analysis_methods(SelectedAnalysisMethod)
/set_selected_analysis_methods(Option<Vec::<SelectedAnalysisMethod>>)
:
required: falseThe analysis methods to enable for the configured table. When configured, you must specify at least two analysis methods.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn 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.
- On success, responds with
CreateConfiguredTableOutput
with field(s):configured_table(Option<ConfiguredTable>)
:The created configured table.
- On failure, responds with
SdkError<CreateConfiguredTableError>
Source§impl Client
impl Client
Sourcepub fn create_configured_table_analysis_rule(
&self,
) -> CreateConfiguredTableAnalysisRuleFluentBuilder
pub fn create_configured_table_analysis_rule( &self, ) -> CreateConfiguredTableAnalysisRuleFluentBuilder
Constructs a fluent builder for the CreateConfiguredTableAnalysisRule
operation.
- The fluent builder is configurable:
configured_table_identifier(impl Into<String>)
/set_configured_table_identifier(Option<String>)
:
required: trueThe identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.
analysis_rule_type(ConfiguredTableAnalysisRuleType)
/set_analysis_rule_type(Option<ConfiguredTableAnalysisRuleType>)
:
required: trueThe type of analysis rule.
analysis_rule_policy(ConfiguredTableAnalysisRulePolicy)
/set_analysis_rule_policy(Option<ConfiguredTableAnalysisRulePolicy>)
:
required: trueThe analysis rule policy that was created for the configured table.
- On success, responds with
CreateConfiguredTableAnalysisRuleOutput
with field(s):analysis_rule(Option<ConfiguredTableAnalysisRule>)
:The analysis rule that was created for the configured table.
- On failure, responds with
SdkError<CreateConfiguredTableAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn create_configured_table_association(
&self,
) -> CreateConfiguredTableAssociationFluentBuilder
pub fn create_configured_table_association( &self, ) -> CreateConfiguredTableAssociationFluentBuilder
Constructs a fluent builder for the CreateConfiguredTableAssociation
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the configured table association. This name is used to query the underlying configured table.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the configured table association.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.
configured_table_identifier(impl Into<String>)
/set_configured_table_identifier(Option<String>)
:
required: trueA unique identifier for the configured table to be associated to. Currently accepts a configured table ID.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe service will assume this role to access catalog metadata and query the table.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn 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.
- On success, responds with
CreateConfiguredTableAssociationOutput
with field(s):configured_table_association(Option<ConfiguredTableAssociation>)
:The configured table association.
- On failure, responds with
SdkError<CreateConfiguredTableAssociationError>
Source§impl Client
impl Client
Sourcepub fn create_configured_table_association_analysis_rule(
&self,
) -> CreateConfiguredTableAssociationAnalysisRuleFluentBuilder
pub fn create_configured_table_association_analysis_rule( &self, ) -> CreateConfiguredTableAssociationAnalysisRuleFluentBuilder
Constructs a fluent builder for the CreateConfiguredTableAssociationAnalysisRule
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
configured_table_association_identifier(impl Into<String>)
/set_configured_table_association_identifier(Option<String>)
:
required: trueThe unique ID for the configured table association. Currently accepts the configured table association ID.
analysis_rule_type(ConfiguredTableAssociationAnalysisRuleType)
/set_analysis_rule_type(Option<ConfiguredTableAssociationAnalysisRuleType>)
:
required: trueThe type of analysis rule.
analysis_rule_policy(ConfiguredTableAssociationAnalysisRulePolicy)
/set_analysis_rule_policy(Option<ConfiguredTableAssociationAnalysisRulePolicy>)
:
required: trueThe analysis rule policy that was created for the configured table association.
- On success, responds with
CreateConfiguredTableAssociationAnalysisRuleOutput
with field(s):analysis_rule(Option<ConfiguredTableAssociationAnalysisRule>)
:The analysis rule for the configured table association. In the console, the
ConfiguredTableAssociationAnalysisRule
is referred to as the collaboration analysis rule.
- On failure, responds with
SdkError<CreateConfiguredTableAssociationAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn create_id_mapping_table(&self) -> CreateIdMappingTableFluentBuilder
pub fn create_id_mapping_table(&self) -> CreateIdMappingTableFluentBuilder
Constructs a fluent builder for the CreateIdMappingTable
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID mapping table.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA name for the ID mapping table.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the ID mapping table.
input_reference_config(IdMappingTableInputReferenceConfig)
/set_input_reference_config(Option<IdMappingTableInputReferenceConfig>)
:
required: trueThe input reference configuration needed to create the ID mapping table.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn 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.
kms_key_arn(impl Into<String>)
/set_kms_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the Amazon Web Services KMS key. This value is used to encrypt the mapping table data that is stored by Clean Rooms.
- On success, responds with
CreateIdMappingTableOutput
with field(s):id_mapping_table(Option<IdMappingTable>)
:The ID mapping table that was created.
- On failure, responds with
SdkError<CreateIdMappingTableError>
Source§impl Client
impl Client
Sourcepub fn create_id_namespace_association(
&self,
) -> CreateIdNamespaceAssociationFluentBuilder
pub fn create_id_namespace_association( &self, ) -> CreateIdNamespaceAssociationFluentBuilder
Constructs a fluent builder for the CreateIdNamespaceAssociation
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID namespace association.
input_reference_config(IdNamespaceAssociationInputReferenceConfig)
/set_input_reference_config(Option<IdNamespaceAssociationInputReferenceConfig>)
:
required: trueThe input reference configuration needed to create the ID namespace association.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn 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.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name for the ID namespace association.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the ID namespace association.
id_mapping_config(IdMappingConfig)
/set_id_mapping_config(Option<IdMappingConfig>)
:
required: falseThe configuration settings for the ID mapping table.
- On success, responds with
CreateIdNamespaceAssociationOutput
with field(s):id_namespace_association(Option<IdNamespaceAssociation>)
:The ID namespace association that was created.
- On failure, responds with
SdkError<CreateIdNamespaceAssociationError>
Source§impl Client
impl Client
Sourcepub fn create_membership(&self) -> CreateMembershipFluentBuilder
pub fn create_membership(&self) -> CreateMembershipFluentBuilder
Constructs a fluent builder for the CreateMembership
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe unique ID for the associated collaboration.
query_log_status(MembershipQueryLogStatus)
/set_query_log_status(Option<MembershipQueryLogStatus>)
:
required: trueAn indicator as to whether query logging has been enabled or disabled for the membership.
When
ENABLED
, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value isDISABLED
.job_log_status(MembershipJobLogStatus)
/set_job_log_status(Option<MembershipJobLogStatus>)
:
required: falseAn indicator as to whether job logging has been enabled or disabled for the collaboration.
When
ENABLED
, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value isDISABLED
.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn 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.
default_result_configuration(MembershipProtectedQueryResultConfiguration)
/set_default_result_configuration(Option<MembershipProtectedQueryResultConfiguration>)
:
required: falseThe default protected query result configuration as specified by the member who can receive results.
default_job_result_configuration(MembershipProtectedJobResultConfiguration)
/set_default_job_result_configuration(Option<MembershipProtectedJobResultConfiguration>)
:
required: falseThe default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.
payment_configuration(MembershipPaymentConfiguration)
/set_payment_configuration(Option<MembershipPaymentConfiguration>)
:
required: falseThe payment responsibilities accepted by the collaboration member.
Not required if the collaboration member has the member ability to run queries.
Required if the collaboration member doesn’t have the member ability to run queries but is configured as a payer by the collaboration creator.
- On success, responds with
CreateMembershipOutput
with field(s):membership(Option<Membership>)
:The membership that was created.
- On failure, responds with
SdkError<CreateMembershipError>
Source§impl Client
impl Client
Sourcepub fn create_privacy_budget_template(
&self,
) -> CreatePrivacyBudgetTemplateFluentBuilder
pub fn create_privacy_budget_template( &self, ) -> CreatePrivacyBudgetTemplateFluentBuilder
Constructs a fluent builder for the CreatePrivacyBudgetTemplate
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.
auto_refresh(PrivacyBudgetTemplateAutoRefresh)
/set_auto_refresh(Option<PrivacyBudgetTemplateAutoRefresh>)
:
required: trueHow often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, you can use
CALENDAR_MONTH
to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.privacy_budget_type(PrivacyBudgetType)
/set_privacy_budget_type(Option<PrivacyBudgetType>)
:
required: trueSpecifies the type of the privacy budget template.
parameters(PrivacyBudgetTemplateParametersInput)
/set_parameters(Option<PrivacyBudgetTemplateParametersInput>)
:
required: trueSpecifies your parameters for the privacy budget template.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAn 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.
- On success, responds with
CreatePrivacyBudgetTemplateOutput
with field(s):privacy_budget_template(Option<PrivacyBudgetTemplate>)
:A summary of the elements in the privacy budget template.
- On failure, responds with
SdkError<CreatePrivacyBudgetTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_analysis_template(&self) -> DeleteAnalysisTemplateFluentBuilder
pub fn delete_analysis_template(&self) -> DeleteAnalysisTemplateFluentBuilder
Constructs a fluent builder for the DeleteAnalysisTemplate
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a membership resource.
analysis_template_identifier(impl Into<String>)
/set_analysis_template_identifier(Option<String>)
:
required: trueThe identifier for the analysis template resource.
- On success, responds with
DeleteAnalysisTemplateOutput
- On failure, responds with
SdkError<DeleteAnalysisTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_collaboration(&self) -> DeleteCollaborationFluentBuilder
pub fn delete_collaboration(&self) -> DeleteCollaborationFluentBuilder
Constructs a fluent builder for the DeleteCollaboration
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe identifier for the collaboration.
- On success, responds with
DeleteCollaborationOutput
- On failure, responds with
SdkError<DeleteCollaborationError>
Source§impl Client
impl Client
Sourcepub fn delete_configured_audience_model_association(
&self,
) -> DeleteConfiguredAudienceModelAssociationFluentBuilder
pub fn delete_configured_audience_model_association( &self, ) -> DeleteConfiguredAudienceModelAssociationFluentBuilder
Constructs a fluent builder for the DeleteConfiguredAudienceModelAssociation
operation.
- The fluent builder is configurable:
configured_audience_model_association_identifier(impl Into<String>)
/set_configured_audience_model_association_identifier(Option<String>)
:
required: trueA unique identifier of the configured audience model association that you want to delete.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier of the membership that contains the audience model association that you want to delete.
- On success, responds with
DeleteConfiguredAudienceModelAssociationOutput
- On failure, responds with
SdkError<DeleteConfiguredAudienceModelAssociationError>
Source§impl Client
impl Client
Sourcepub fn delete_configured_table(&self) -> DeleteConfiguredTableFluentBuilder
pub fn delete_configured_table(&self) -> DeleteConfiguredTableFluentBuilder
Constructs a fluent builder for the DeleteConfiguredTable
operation.
- The fluent builder is configurable:
configured_table_identifier(impl Into<String>)
/set_configured_table_identifier(Option<String>)
:
required: trueThe unique ID for the configured table to delete.
- On success, responds with
DeleteConfiguredTableOutput
- On failure, responds with
SdkError<DeleteConfiguredTableError>
Source§impl Client
impl Client
Sourcepub fn delete_configured_table_analysis_rule(
&self,
) -> DeleteConfiguredTableAnalysisRuleFluentBuilder
pub fn delete_configured_table_analysis_rule( &self, ) -> DeleteConfiguredTableAnalysisRuleFluentBuilder
Constructs a fluent builder for the DeleteConfiguredTableAnalysisRule
operation.
- The fluent builder is configurable:
configured_table_identifier(impl Into<String>)
/set_configured_table_identifier(Option<String>)
:
required: trueThe unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
analysis_rule_type(ConfiguredTableAnalysisRuleType)
/set_analysis_rule_type(Option<ConfiguredTableAnalysisRuleType>)
:
required: trueThe analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
- On success, responds with
DeleteConfiguredTableAnalysisRuleOutput
- On failure, responds with
SdkError<DeleteConfiguredTableAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_configured_table_association(
&self,
) -> DeleteConfiguredTableAssociationFluentBuilder
pub fn delete_configured_table_association( &self, ) -> DeleteConfiguredTableAssociationFluentBuilder
Constructs a fluent builder for the DeleteConfiguredTableAssociation
operation.
- The fluent builder is configurable:
configured_table_association_identifier(impl Into<String>)
/set_configured_table_association_identifier(Option<String>)
:
required: trueThe unique ID for the configured table association to be deleted. Currently accepts the configured table ID.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
- On success, responds with
DeleteConfiguredTableAssociationOutput
- On failure, responds with
SdkError<DeleteConfiguredTableAssociationError>
Source§impl Client
impl Client
Sourcepub fn delete_configured_table_association_analysis_rule(
&self,
) -> DeleteConfiguredTableAssociationAnalysisRuleFluentBuilder
pub fn delete_configured_table_association_analysis_rule( &self, ) -> DeleteConfiguredTableAssociationAnalysisRuleFluentBuilder
Constructs a fluent builder for the DeleteConfiguredTableAssociationAnalysisRule
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
configured_table_association_identifier(impl Into<String>)
/set_configured_table_association_identifier(Option<String>)
:
required: trueThe identifier for the configured table association that’s related to the analysis rule that you want to delete.
analysis_rule_type(ConfiguredTableAssociationAnalysisRuleType)
/set_analysis_rule_type(Option<ConfiguredTableAssociationAnalysisRuleType>)
:
required: trueThe type of the analysis rule that you want to delete.
- On success, responds with
DeleteConfiguredTableAssociationAnalysisRuleOutput
- On failure, responds with
SdkError<DeleteConfiguredTableAssociationAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn delete_id_mapping_table(&self) -> DeleteIdMappingTableFluentBuilder
pub fn delete_id_mapping_table(&self) -> DeleteIdMappingTableFluentBuilder
Constructs a fluent builder for the DeleteIdMappingTable
operation.
- The fluent builder is configurable:
id_mapping_table_identifier(impl Into<String>)
/set_id_mapping_table_identifier(Option<String>)
:
required: trueThe unique identifier of the ID mapping table that you want to delete.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID mapping table that you want to delete.
- On success, responds with
DeleteIdMappingTableOutput
- On failure, responds with
SdkError<DeleteIdMappingTableError>
Source§impl Client
impl Client
Sourcepub fn delete_id_namespace_association(
&self,
) -> DeleteIdNamespaceAssociationFluentBuilder
pub fn delete_id_namespace_association( &self, ) -> DeleteIdNamespaceAssociationFluentBuilder
Constructs a fluent builder for the DeleteIdNamespaceAssociation
operation.
- The fluent builder is configurable:
id_namespace_association_identifier(impl Into<String>)
/set_id_namespace_association_identifier(Option<String>)
:
required: trueThe unique identifier of the ID namespace association that you want to delete.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID namespace association that you want to delete.
- On success, responds with
DeleteIdNamespaceAssociationOutput
- On failure, responds with
SdkError<DeleteIdNamespaceAssociationError>
Source§impl Client
impl Client
Sourcepub fn delete_member(&self) -> DeleteMemberFluentBuilder
pub fn delete_member(&self) -> DeleteMemberFluentBuilder
Constructs a fluent builder for the DeleteMember
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe unique identifier for the associated collaboration.
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: trueThe account ID of the member to remove.
- On success, responds with
DeleteMemberOutput
- On failure, responds with
SdkError<DeleteMemberError>
Source§impl Client
impl Client
Sourcepub fn delete_membership(&self) -> DeleteMembershipFluentBuilder
pub fn delete_membership(&self) -> DeleteMembershipFluentBuilder
Constructs a fluent builder for the DeleteMembership
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a membership resource.
- On success, responds with
DeleteMembershipOutput
- On failure, responds with
SdkError<DeleteMembershipError>
Source§impl Client
impl Client
Sourcepub fn delete_privacy_budget_template(
&self,
) -> DeletePrivacyBudgetTemplateFluentBuilder
pub fn delete_privacy_budget_template( &self, ) -> DeletePrivacyBudgetTemplateFluentBuilder
Constructs a fluent builder for the DeletePrivacyBudgetTemplate
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID.
privacy_budget_template_identifier(impl Into<String>)
/set_privacy_budget_template_identifier(Option<String>)
:
required: trueA unique identifier for your privacy budget template.
- On success, responds with
DeletePrivacyBudgetTemplateOutput
- On failure, responds with
SdkError<DeletePrivacyBudgetTemplateError>
Source§impl Client
impl Client
Sourcepub fn get_analysis_template(&self) -> GetAnalysisTemplateFluentBuilder
pub fn get_analysis_template(&self) -> GetAnalysisTemplateFluentBuilder
Constructs a fluent builder for the GetAnalysisTemplate
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a membership resource.
analysis_template_identifier(impl Into<String>)
/set_analysis_template_identifier(Option<String>)
:
required: trueThe identifier for the analysis template resource.
- On success, responds with
GetAnalysisTemplateOutput
with field(s):analysis_template(Option<AnalysisTemplate>)
:The analysis template.
- On failure, responds with
SdkError<GetAnalysisTemplateError>
Source§impl Client
impl Client
Sourcepub fn get_collaboration(&self) -> GetCollaborationFluentBuilder
pub fn get_collaboration(&self) -> GetCollaborationFluentBuilder
Constructs a fluent builder for the GetCollaboration
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe identifier for the collaboration.
- On success, responds with
GetCollaborationOutput
with field(s):collaboration(Option<Collaboration>)
:The entire collaboration for this identifier.
- On failure, responds with
SdkError<GetCollaborationError>
Source§impl Client
impl Client
Sourcepub fn get_collaboration_analysis_template(
&self,
) -> GetCollaborationAnalysisTemplateFluentBuilder
pub fn get_collaboration_analysis_template( &self, ) -> GetCollaborationAnalysisTemplateFluentBuilder
Constructs a fluent builder for the GetCollaborationAnalysisTemplate
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
analysis_template_arn(impl Into<String>)
/set_analysis_template_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
- On success, responds with
GetCollaborationAnalysisTemplateOutput
with field(s):collaboration_analysis_template(Option<CollaborationAnalysisTemplate>)
:The analysis template within a collaboration.
- On failure, responds with
SdkError<GetCollaborationAnalysisTemplateError>
Source§impl Client
impl Client
Sourcepub fn get_collaboration_change_request(
&self,
) -> GetCollaborationChangeRequestFluentBuilder
pub fn get_collaboration_change_request( &self, ) -> GetCollaborationChangeRequestFluentBuilder
Constructs a fluent builder for the GetCollaborationChangeRequest
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe identifier of the collaboration that the change request is made against.
change_request_identifier(impl Into<String>)
/set_change_request_identifier(Option<String>)
:
required: trueA unique identifier for the change request to retrieve.
- On success, responds with
GetCollaborationChangeRequestOutput
with field(s):collaboration_change_request(Option<CollaborationChangeRequest>)
:The collaboration change request that was requested.
- On failure, responds with
SdkError<GetCollaborationChangeRequestError>
Source§impl Client
impl Client
Sourcepub fn get_collaboration_configured_audience_model_association(
&self,
) -> GetCollaborationConfiguredAudienceModelAssociationFluentBuilder
pub fn get_collaboration_configured_audience_model_association( &self, ) -> GetCollaborationConfiguredAudienceModelAssociationFluentBuilder
Constructs a fluent builder for the GetCollaborationConfiguredAudienceModelAssociation
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.
configured_audience_model_association_identifier(impl Into<String>)
/set_configured_audience_model_association_identifier(Option<String>)
:
required: trueA unique identifier for the configured audience model association that you want to retrieve.
- On success, responds with
GetCollaborationConfiguredAudienceModelAssociationOutput
with field(s):collaboration_configured_audience_model_association(Option<CollaborationConfiguredAudienceModelAssociation>)
:The metadata of the configured audience model association.
- On failure, responds with
SdkError<GetCollaborationConfiguredAudienceModelAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_collaboration_id_namespace_association(
&self,
) -> GetCollaborationIdNamespaceAssociationFluentBuilder
pub fn get_collaboration_id_namespace_association( &self, ) -> GetCollaborationIdNamespaceAssociationFluentBuilder
Constructs a fluent builder for the GetCollaborationIdNamespaceAssociation
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe unique identifier of the collaboration that contains the ID namespace association that you want to retrieve.
id_namespace_association_identifier(impl Into<String>)
/set_id_namespace_association_identifier(Option<String>)
:
required: trueThe unique identifier of the ID namespace association that you want to retrieve.
- On success, responds with
GetCollaborationIdNamespaceAssociationOutput
with field(s):collaboration_id_namespace_association(Option<CollaborationIdNamespaceAssociation>)
:The ID namespace association that you requested.
- On failure, responds with
SdkError<GetCollaborationIdNamespaceAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_collaboration_privacy_budget_template(
&self,
) -> GetCollaborationPrivacyBudgetTemplateFluentBuilder
pub fn get_collaboration_privacy_budget_template( &self, ) -> GetCollaborationPrivacyBudgetTemplateFluentBuilder
Constructs a fluent builder for the GetCollaborationPrivacyBudgetTemplate
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for one of your collaborations.
privacy_budget_template_identifier(impl Into<String>)
/set_privacy_budget_template_identifier(Option<String>)
:
required: trueA unique identifier for one of your privacy budget templates.
- On success, responds with
GetCollaborationPrivacyBudgetTemplateOutput
with field(s):collaboration_privacy_budget_template(Option<CollaborationPrivacyBudgetTemplate>)
:Returns the details of the privacy budget template that you requested.
- On failure, responds with
SdkError<GetCollaborationPrivacyBudgetTemplateError>
Source§impl Client
impl Client
Sourcepub fn get_configured_audience_model_association(
&self,
) -> GetConfiguredAudienceModelAssociationFluentBuilder
pub fn get_configured_audience_model_association( &self, ) -> GetConfiguredAudienceModelAssociationFluentBuilder
Constructs a fluent builder for the GetConfiguredAudienceModelAssociation
operation.
- The fluent builder is configurable:
configured_audience_model_association_identifier(impl Into<String>)
/set_configured_audience_model_association_identifier(Option<String>)
:
required: trueA unique identifier for the configured audience model association that you want to retrieve.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership that contains the configured audience model association that you want to retrieve.
- On success, responds with
GetConfiguredAudienceModelAssociationOutput
with field(s):configured_audience_model_association(Option<ConfiguredAudienceModelAssociation>)
:Information about the configured audience model association that you requested.
- On failure, responds with
SdkError<GetConfiguredAudienceModelAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_configured_table(&self) -> GetConfiguredTableFluentBuilder
pub fn get_configured_table(&self) -> GetConfiguredTableFluentBuilder
Constructs a fluent builder for the GetConfiguredTable
operation.
- The fluent builder is configurable:
configured_table_identifier(impl Into<String>)
/set_configured_table_identifier(Option<String>)
:
required: trueThe unique ID for the configured table to retrieve.
- On success, responds with
GetConfiguredTableOutput
with field(s):configured_table(Option<ConfiguredTable>)
:The retrieved configured table.
- On failure, responds with
SdkError<GetConfiguredTableError>
Source§impl Client
impl Client
Sourcepub fn get_configured_table_analysis_rule(
&self,
) -> GetConfiguredTableAnalysisRuleFluentBuilder
pub fn get_configured_table_analysis_rule( &self, ) -> GetConfiguredTableAnalysisRuleFluentBuilder
Constructs a fluent builder for the GetConfiguredTableAnalysisRule
operation.
- The fluent builder is configurable:
configured_table_identifier(impl Into<String>)
/set_configured_table_identifier(Option<String>)
:
required: trueThe unique identifier for the configured table to retrieve. Currently accepts the configured table ID.
analysis_rule_type(ConfiguredTableAnalysisRuleType)
/set_analysis_rule_type(Option<ConfiguredTableAnalysisRuleType>)
:
required: trueThe analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
- On success, responds with
GetConfiguredTableAnalysisRuleOutput
with field(s):analysis_rule(Option<ConfiguredTableAnalysisRule>)
:The entire analysis rule output.
- On failure, responds with
SdkError<GetConfiguredTableAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn get_configured_table_association(
&self,
) -> GetConfiguredTableAssociationFluentBuilder
pub fn get_configured_table_association( &self, ) -> GetConfiguredTableAssociationFluentBuilder
Constructs a fluent builder for the GetConfiguredTableAssociation
operation.
- The fluent builder is configurable:
configured_table_association_identifier(impl Into<String>)
/set_configured_table_association_identifier(Option<String>)
:
required: trueThe unique ID for the configured table association to retrieve. Currently accepts the configured table ID.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
- On success, responds with
GetConfiguredTableAssociationOutput
with field(s):configured_table_association(Option<ConfiguredTableAssociation>)
:The entire configured table association object.
- On failure, responds with
SdkError<GetConfiguredTableAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_configured_table_association_analysis_rule(
&self,
) -> GetConfiguredTableAssociationAnalysisRuleFluentBuilder
pub fn get_configured_table_association_analysis_rule( &self, ) -> GetConfiguredTableAssociationAnalysisRuleFluentBuilder
Constructs a fluent builder for the GetConfiguredTableAssociationAnalysisRule
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
configured_table_association_identifier(impl Into<String>)
/set_configured_table_association_identifier(Option<String>)
:
required: trueThe identifier for the configured table association that’s related to the analysis rule.
analysis_rule_type(ConfiguredTableAssociationAnalysisRuleType)
/set_analysis_rule_type(Option<ConfiguredTableAssociationAnalysisRuleType>)
:
required: trueThe type of analysis rule that you want to retrieve.
- On success, responds with
GetConfiguredTableAssociationAnalysisRuleOutput
with field(s):analysis_rule(Option<ConfiguredTableAssociationAnalysisRule>)
:The analysis rule for the configured table association. In the console, the
ConfiguredTableAssociationAnalysisRule
is referred to as the collaboration analysis rule.
- On failure, responds with
SdkError<GetConfiguredTableAssociationAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn get_id_mapping_table(&self) -> GetIdMappingTableFluentBuilder
pub fn get_id_mapping_table(&self) -> GetIdMappingTableFluentBuilder
Constructs a fluent builder for the GetIdMappingTable
operation.
- The fluent builder is configurable:
id_mapping_table_identifier(impl Into<String>)
/set_id_mapping_table_identifier(Option<String>)
:
required: trueThe unique identifier of the ID mapping table identifier that you want to retrieve.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID mapping table that you want to retrieve.
- On success, responds with
GetIdMappingTableOutput
with field(s):id_mapping_table(Option<IdMappingTable>)
:The ID mapping table that you requested.
- On failure, responds with
SdkError<GetIdMappingTableError>
Source§impl Client
impl Client
Sourcepub fn get_id_namespace_association(
&self,
) -> GetIdNamespaceAssociationFluentBuilder
pub fn get_id_namespace_association( &self, ) -> GetIdNamespaceAssociationFluentBuilder
Constructs a fluent builder for the GetIdNamespaceAssociation
operation.
- The fluent builder is configurable:
id_namespace_association_identifier(impl Into<String>)
/set_id_namespace_association_identifier(Option<String>)
:
required: trueThe unique identifier of the ID namespace association that you want to retrieve.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID namespace association that you want to retrieve.
- On success, responds with
GetIdNamespaceAssociationOutput
with field(s):id_namespace_association(Option<IdNamespaceAssociation>)
:The ID namespace association that you requested.
- On failure, responds with
SdkError<GetIdNamespaceAssociationError>
Source§impl Client
impl Client
Sourcepub fn get_membership(&self) -> GetMembershipFluentBuilder
pub fn get_membership(&self) -> GetMembershipFluentBuilder
Constructs a fluent builder for the GetMembership
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a membership resource.
- On success, responds with
GetMembershipOutput
with field(s):membership(Option<Membership>)
:The membership retrieved for the provided identifier.
- On failure, responds with
SdkError<GetMembershipError>
Source§impl Client
impl Client
Sourcepub fn get_privacy_budget_template(
&self,
) -> GetPrivacyBudgetTemplateFluentBuilder
pub fn get_privacy_budget_template( &self, ) -> GetPrivacyBudgetTemplateFluentBuilder
Constructs a fluent builder for the GetPrivacyBudgetTemplate
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for one of your memberships for a collaboration. The privacy budget template is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
privacy_budget_template_identifier(impl Into<String>)
/set_privacy_budget_template_identifier(Option<String>)
:
required: trueA unique identifier for your privacy budget template.
- On success, responds with
GetPrivacyBudgetTemplateOutput
with field(s):privacy_budget_template(Option<PrivacyBudgetTemplate>)
:Returns the details of the privacy budget template that you requested.
- On failure, responds with
SdkError<GetPrivacyBudgetTemplateError>
Source§impl Client
impl Client
Sourcepub fn get_protected_job(&self) -> GetProtectedJobFluentBuilder
pub fn get_protected_job(&self) -> GetProtectedJobFluentBuilder
Constructs a fluent builder for the GetProtectedJob
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a membership in a protected job instance.
protected_job_identifier(impl Into<String>)
/set_protected_job_identifier(Option<String>)
:
required: trueThe identifier for the protected job instance.
- On success, responds with
GetProtectedJobOutput
with field(s):protected_job(Option<ProtectedJob>)
:The protected job metadata.
- On failure, responds with
SdkError<GetProtectedJobError>
Source§impl Client
impl Client
Sourcepub fn get_protected_query(&self) -> GetProtectedQueryFluentBuilder
pub fn get_protected_query(&self) -> GetProtectedQueryFluentBuilder
Constructs a fluent builder for the GetProtectedQuery
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a membership in a protected query instance.
protected_query_identifier(impl Into<String>)
/set_protected_query_identifier(Option<String>)
:
required: trueThe identifier for a protected query instance.
- On success, responds with
GetProtectedQueryOutput
with field(s):protected_query(Option<ProtectedQuery>)
:The query processing metadata.
- On failure, responds with
SdkError<GetProtectedQueryError>
Source§impl Client
impl Client
Sourcepub fn get_schema(&self) -> GetSchemaFluentBuilder
pub fn get_schema(&self) -> GetSchemaFluentBuilder
Constructs a fluent builder for the GetSchema
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the relation to retrieve the schema for.
- On success, responds with
GetSchemaOutput
with field(s):schema(Option<Schema>)
:The entire schema object.
- On failure, responds with
SdkError<GetSchemaError>
Source§impl Client
impl Client
Sourcepub fn get_schema_analysis_rule(&self) -> GetSchemaAnalysisRuleFluentBuilder
pub fn get_schema_analysis_rule(&self) -> GetSchemaAnalysisRuleFluentBuilder
Constructs a fluent builder for the GetSchemaAnalysisRule
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the schema to retrieve the analysis rule for.
r#type(AnalysisRuleType)
/set_type(Option<AnalysisRuleType>)
:
required: trueThe type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
- On success, responds with
GetSchemaAnalysisRuleOutput
with field(s):analysis_rule(Option<AnalysisRule>)
:A specification about how data from the configured table can be used.
- On failure, responds with
SdkError<GetSchemaAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn list_analysis_templates(&self) -> ListAnalysisTemplatesFluentBuilder
pub fn list_analysis_templates(&self) -> ListAnalysisTemplatesFluentBuilder
Constructs a fluent builder for the ListAnalysisTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a membership resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListAnalysisTemplatesOutput
with field(s):next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
analysis_template_summaries(Vec::<AnalysisTemplateSummary>)
:Lists analysis template metadata.
- On failure, responds with
SdkError<ListAnalysisTemplatesError>
Source§impl Client
impl Client
Sourcepub fn list_collaboration_analysis_templates(
&self,
) -> ListCollaborationAnalysisTemplatesFluentBuilder
pub fn list_collaboration_analysis_templates( &self, ) -> ListCollaborationAnalysisTemplatesFluentBuilder
Constructs a fluent builder for the ListCollaborationAnalysisTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListCollaborationAnalysisTemplatesOutput
with field(s):next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
collaboration_analysis_template_summaries(Vec::<CollaborationAnalysisTemplateSummary>)
:The metadata of the analysis template within a collaboration.
- On failure, responds with
SdkError<ListCollaborationAnalysisTemplatesError>
Source§impl Client
impl Client
Sourcepub fn list_collaboration_change_requests(
&self,
) -> ListCollaborationChangeRequestsFluentBuilder
pub fn list_collaboration_change_requests( &self, ) -> ListCollaborationChangeRequestsFluentBuilder
Constructs a fluent builder for the ListCollaborationChangeRequests
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe identifier of the collaboration that the change request is made against.
status(ChangeRequestStatus)
/set_status(Option<ChangeRequestStatus>)
:
required: falseA filter to only return change requests with the specified status.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call.
- On success, responds with
ListCollaborationChangeRequestsOutput
with field(s):collaboration_change_request_summaries(Vec::<CollaborationChangeRequestSummary>)
:The list of collaboration change request summaries.
next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
- On failure, responds with
SdkError<ListCollaborationChangeRequestsError>
Source§impl Client
impl Client
Sourcepub fn list_collaboration_configured_audience_model_associations(
&self,
) -> ListCollaborationConfiguredAudienceModelAssociationsFluentBuilder
pub fn list_collaboration_configured_audience_model_associations( &self, ) -> ListCollaborationConfiguredAudienceModelAssociationsFluentBuilder
Constructs a fluent builder for the ListCollaborationConfiguredAudienceModelAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListCollaborationConfiguredAudienceModelAssociationsOutput
with field(s):collaboration_configured_audience_model_association_summaries(Vec::<CollaborationConfiguredAudienceModelAssociationSummary>)
:The metadata of the configured audience model association within a collaboration.
next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
- On failure, responds with
SdkError<ListCollaborationConfiguredAudienceModelAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_collaboration_id_namespace_associations(
&self,
) -> ListCollaborationIdNamespaceAssociationsFluentBuilder
pub fn list_collaboration_id_namespace_associations( &self, ) -> ListCollaborationIdNamespaceAssociationsFluentBuilder
Constructs a fluent builder for the ListCollaborationIdNamespaceAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe unique identifier of the collaboration that contains the ID namespace associations that you want to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.>
- On success, responds with
ListCollaborationIdNamespaceAssociationsOutput
with field(s):next_token(Option<String>)
:The token value provided to access the next page of results.
collaboration_id_namespace_association_summaries(Vec::<CollaborationIdNamespaceAssociationSummary>)
:The summary information of the collaboration ID namespace associations that you requested.
- On failure, responds with
SdkError<ListCollaborationIdNamespaceAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_collaboration_privacy_budget_templates(
&self,
) -> ListCollaborationPrivacyBudgetTemplatesFluentBuilder
pub fn list_collaboration_privacy_budget_templates( &self, ) -> ListCollaborationPrivacyBudgetTemplatesFluentBuilder
Constructs a fluent builder for the ListCollaborationPrivacyBudgetTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for one of your collaborations.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListCollaborationPrivacyBudgetTemplatesOutput
with field(s):next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
collaboration_privacy_budget_template_summaries(Vec::<CollaborationPrivacyBudgetTemplateSummary>)
:An array that summarizes the collaboration privacy budget templates. The summary includes collaboration information, creation information, the privacy budget type.
- On failure, responds with
SdkError<ListCollaborationPrivacyBudgetTemplatesError>
Source§impl Client
impl Client
Sourcepub fn list_collaboration_privacy_budgets(
&self,
) -> ListCollaborationPrivacyBudgetsFluentBuilder
pub fn list_collaboration_privacy_budgets( &self, ) -> ListCollaborationPrivacyBudgetsFluentBuilder
Constructs a fluent builder for the ListCollaborationPrivacyBudgets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for one of your collaborations.
privacy_budget_type(PrivacyBudgetType)
/set_privacy_budget_type(Option<PrivacyBudgetType>)
:
required: trueSpecifies the type of the privacy budget.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
- On success, responds with
ListCollaborationPrivacyBudgetsOutput
with field(s):collaboration_privacy_budget_summaries(Vec::<CollaborationPrivacyBudgetSummary>)
:Summaries of the collaboration privacy budgets.
next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
- On failure, responds with
SdkError<ListCollaborationPrivacyBudgetsError>
Source§impl Client
impl Client
Sourcepub fn list_collaborations(&self) -> ListCollaborationsFluentBuilder
pub fn list_collaborations(&self) -> ListCollaborationsFluentBuilder
Constructs a fluent builder for the ListCollaborations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.member_status(FilterableMemberStatus)
/set_member_status(Option<FilterableMemberStatus>)
:
required: falseThe caller’s status in a collaboration.
- On success, responds with
ListCollaborationsOutput
with field(s):next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
collaboration_list(Vec::<CollaborationSummary>)
:The list of collaborations.
- On failure, responds with
SdkError<ListCollaborationsError>
Source§impl Client
impl Client
Sourcepub fn list_configured_audience_model_associations(
&self,
) -> ListConfiguredAudienceModelAssociationsFluentBuilder
pub fn list_configured_audience_model_associations( &self, ) -> ListConfiguredAudienceModelAssociationsFluentBuilder
Constructs a fluent builder for the ListConfiguredAudienceModelAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for a membership that contains the configured audience model associations that you want to retrieve.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListConfiguredAudienceModelAssociationsOutput
with field(s):configured_audience_model_association_summaries(Vec::<ConfiguredAudienceModelAssociationSummary>)
:Summaries of the configured audience model associations that you requested.
next_token(Option<String>)
:The token value provided to access the next page of results.
- On failure, responds with
SdkError<ListConfiguredAudienceModelAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_configured_table_associations(
&self,
) -> ListConfiguredTableAssociationsFluentBuilder
pub fn list_configured_table_associations( &self, ) -> ListConfiguredTableAssociationsFluentBuilder
Constructs a fluent builder for the ListConfiguredTableAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListConfiguredTableAssociationsOutput
with field(s):configured_table_association_summaries(Vec::<ConfiguredTableAssociationSummary>)
:The retrieved list of configured table associations.
next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
- On failure, responds with
SdkError<ListConfiguredTableAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_configured_tables(&self) -> ListConfiguredTablesFluentBuilder
pub fn list_configured_tables(&self) -> ListConfiguredTablesFluentBuilder
Constructs a fluent builder for the ListConfiguredTables
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListConfiguredTablesOutput
with field(s):configured_table_summaries(Vec::<ConfiguredTableSummary>)
:The configured tables listed by the request.
next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
- On failure, responds with
SdkError<ListConfiguredTablesError>
Source§impl Client
impl Client
Sourcepub fn list_id_mapping_tables(&self) -> ListIdMappingTablesFluentBuilder
pub fn list_id_mapping_tables(&self) -> ListIdMappingTablesFluentBuilder
Constructs a fluent builder for the ListIdMappingTables
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID mapping tables that you want to view.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
- On success, responds with
ListIdMappingTablesOutput
with field(s):id_mapping_table_summaries(Vec::<IdMappingTableSummary>)
:The summary information of the ID mapping tables that you requested.
next_token(Option<String>)
:The token value provided to access the next page of results.
- On failure, responds with
SdkError<ListIdMappingTablesError>
Source§impl Client
impl Client
Sourcepub fn list_id_namespace_associations(
&self,
) -> ListIdNamespaceAssociationsFluentBuilder
pub fn list_id_namespace_associations( &self, ) -> ListIdNamespaceAssociationsFluentBuilder
Constructs a fluent builder for the ListIdNamespaceAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID namespace association that you want to view.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
- On success, responds with
ListIdNamespaceAssociationsOutput
with field(s):next_token(Option<String>)
:The token value provided to access the next page of results.
id_namespace_association_summaries(Vec::<IdNamespaceAssociationSummary>)
:The summary information of the ID namespace associations that you requested.
- On failure, responds with
SdkError<ListIdNamespaceAssociationsError>
Source§impl Client
impl Client
Sourcepub fn list_members(&self) -> ListMembersFluentBuilder
pub fn list_members(&self) -> ListMembersFluentBuilder
Constructs a fluent builder for the ListMembers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe identifier of the collaboration in which the members are listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListMembersOutput
with field(s):next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
member_summaries(Vec::<MemberSummary>)
:The list of members returned by the ListMembers operation.
- On failure, responds with
SdkError<ListMembersError>
Source§impl Client
impl Client
Sourcepub fn list_memberships(&self) -> ListMembershipsFluentBuilder
pub fn list_memberships(&self) -> ListMembershipsFluentBuilder
Constructs a fluent builder for the ListMemberships
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.status(MembershipStatus)
/set_status(Option<MembershipStatus>)
:
required: falseA filter which will return only memberships in the specified status.
- On success, responds with
ListMembershipsOutput
with field(s):next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
membership_summaries(Vec::<MembershipSummary>)
:The list of memberships returned from the ListMemberships operation.
- On failure, responds with
SdkError<ListMembershipsError>
Source§impl Client
impl Client
Sourcepub fn list_privacy_budget_templates(
&self,
) -> ListPrivacyBudgetTemplatesFluentBuilder
pub fn list_privacy_budget_templates( &self, ) -> ListPrivacyBudgetTemplatesFluentBuilder
Constructs a fluent builder for the ListPrivacyBudgetTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListPrivacyBudgetTemplatesOutput
with field(s):next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
privacy_budget_template_summaries(Vec::<PrivacyBudgetTemplateSummary>)
:An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.
- On failure, responds with
SdkError<ListPrivacyBudgetTemplatesError>
Source§impl Client
impl Client
Sourcepub fn list_privacy_budgets(&self) -> ListPrivacyBudgetsFluentBuilder
pub fn list_privacy_budgets(&self) -> ListPrivacyBudgetsFluentBuilder
Constructs a fluent builder for the ListPrivacyBudgets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
privacy_budget_type(PrivacyBudgetType)
/set_privacy_budget_type(Option<PrivacyBudgetType>)
:
required: trueThe privacy budget type.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListPrivacyBudgetsOutput
with field(s):privacy_budget_summaries(Vec::<PrivacyBudgetSummary>)
:An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.
next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
- On failure, responds with
SdkError<ListPrivacyBudgetsError>
Source§impl Client
impl Client
Sourcepub fn list_protected_jobs(&self) -> ListProtectedJobsFluentBuilder
pub fn list_protected_jobs(&self) -> ListProtectedJobsFluentBuilder
Constructs a fluent builder for the ListProtectedJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for the membership in the collaboration.
status(ProtectedJobStatus)
/set_status(Option<ProtectedJobStatus>)
:
required: falseA filter on the status of the protected job.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListProtectedJobsOutput
with field(s):next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
protected_jobs(Vec::<ProtectedJobSummary>)
:A list of protected job summaries.
- On failure, responds with
SdkError<ListProtectedJobsError>
Source§impl Client
impl Client
Sourcepub fn list_protected_queries(&self) -> ListProtectedQueriesFluentBuilder
pub fn list_protected_queries(&self) -> ListProtectedQueriesFluentBuilder
Constructs a fluent builder for the ListProtectedQueries
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for the membership in the collaboration.
status(ProtectedQueryStatus)
/set_status(Option<ProtectedQueryStatus>)
:
required: falseA filter on the status of the protected query.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListProtectedQueriesOutput
with field(s):next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
protected_queries(Vec::<ProtectedQuerySummary>)
:A list of protected queries.
- On failure, responds with
SdkError<ListProtectedQueriesError>
Source§impl Client
impl Client
Sourcepub fn list_schemas(&self) -> ListSchemasFluentBuilder
pub fn list_schemas(&self) -> ListSchemasFluentBuilder
Constructs a fluent builder for the ListSchemas
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueA unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
schema_type(SchemaType)
/set_schema_type(Option<SchemaType>)
:
required: falseIf present, filter schemas by schema type.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token that’s used to fetch the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a
nextToken
even if themaxResults
value has not been met.
- On success, responds with
ListSchemasOutput
with field(s):schema_summaries(Vec::<SchemaSummary>)
:The retrieved list of schemas.
next_token(Option<String>)
:The pagination token that’s used to fetch the next set of results.
- On failure, responds with
SdkError<ListSchemasError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) associated with the resource you want to list tags on.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(HashMap::<String, String>)
:A map of objects specifying each key name and value.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn populate_id_mapping_table(&self) -> PopulateIdMappingTableFluentBuilder
pub fn populate_id_mapping_table(&self) -> PopulateIdMappingTableFluentBuilder
Constructs a fluent builder for the PopulateIdMappingTable
operation.
- The fluent builder is configurable:
id_mapping_table_identifier(impl Into<String>)
/set_id_mapping_table_identifier(Option<String>)
:
required: trueThe unique identifier of the ID mapping table that you want to populate.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID mapping table that you want to populate.
job_type(JobType)
/set_job_type(Option<JobType>)
:
required: falseThe job type of the rule-based ID mapping job. Valid values include:
INCREMENTAL
: Processes only new or changed data since the last job run. This is the default job type if the ID mapping workflow was created in Entity Resolution withincrementalRunConfig
specified.BATCH
: Processes all data from the input source, regardless of previous job runs. This is the default job type if the ID mapping workflow was created in Entity Resolution butincrementalRunConfig
wasn’t specified.DELETE_ONLY
: Processes only deletion requests fromBatchDeleteUniqueId
, which is set in Entity Resolution.For more information about
incrementalRunConfig
andBatchDeleteUniqueId
, see the Entity Resolution API Reference.
- On success, responds with
PopulateIdMappingTableOutput
with field(s):id_mapping_job_id(String)
:The unique identifier of the mapping job that will populate the ID mapping table.
- On failure, responds with
SdkError<PopulateIdMappingTableError>
Source§impl Client
impl Client
Sourcepub fn preview_privacy_impact(&self) -> PreviewPrivacyImpactFluentBuilder
pub fn preview_privacy_impact(&self) -> PreviewPrivacyImpactFluentBuilder
Constructs a fluent builder for the PreviewPrivacyImpact
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for one of your memberships for a collaboration. Accepts a membership ID.
parameters(PreviewPrivacyImpactParametersInput)
/set_parameters(Option<PreviewPrivacyImpactParametersInput>)
:
required: trueSpecifies the desired epsilon and noise parameters to preview.
- On success, responds with
PreviewPrivacyImpactOutput
with field(s):privacy_impact(Option<PrivacyImpact>)
:An estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters. This does not change the privacy budget.
- On failure, responds with
SdkError<PreviewPrivacyImpactError>
Source§impl Client
impl Client
Sourcepub fn start_protected_job(&self) -> StartProtectedJobFluentBuilder
pub fn start_protected_job(&self) -> StartProtectedJobFluentBuilder
Constructs a fluent builder for the StartProtectedJob
operation.
- The fluent builder is configurable:
r#type(ProtectedJobType)
/set_type(Option<ProtectedJobType>)
:
required: trueThe type of protected job to start.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership to run this job against. Currently accepts a membership ID.
job_parameters(ProtectedJobParameters)
/set_job_parameters(Option<ProtectedJobParameters>)
:
required: trueThe job parameters.
result_configuration(ProtectedJobResultConfigurationInput)
/set_result_configuration(Option<ProtectedJobResultConfigurationInput>)
:
required: falseThe details needed to write the job results.
compute_configuration(ProtectedJobComputeConfiguration)
/set_compute_configuration(Option<ProtectedJobComputeConfiguration>)
:
required: falseThe compute configuration for the protected job.
- On success, responds with
StartProtectedJobOutput
with field(s):protected_job(Option<ProtectedJob>)
:The protected job.
- On failure, responds with
SdkError<StartProtectedJobError>
Source§impl Client
impl Client
Sourcepub fn start_protected_query(&self) -> StartProtectedQueryFluentBuilder
pub fn start_protected_query(&self) -> StartProtectedQueryFluentBuilder
Constructs a fluent builder for the StartProtectedQuery
operation.
- The fluent builder is configurable:
r#type(ProtectedQueryType)
/set_type(Option<ProtectedQueryType>)
:
required: trueThe type of the protected query to be started.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership to run this query against. Currently accepts a membership ID.
sql_parameters(ProtectedQuerySqlParameters)
/set_sql_parameters(Option<ProtectedQuerySqlParameters>)
:
required: trueThe protected SQL query parameters.
result_configuration(ProtectedQueryResultConfiguration)
/set_result_configuration(Option<ProtectedQueryResultConfiguration>)
:
required: falseThe details needed to write the query results.
compute_configuration(ComputeConfiguration)
/set_compute_configuration(Option<ComputeConfiguration>)
:
required: falseThe compute configuration for the protected query.
- On success, responds with
StartProtectedQueryOutput
with field(s):protected_query(Option<ProtectedQuery>)
:The protected query.
- On failure, responds with
SdkError<StartProtectedQueryError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) associated with the resource you want to tag.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueA map of objects specifying each key name and value.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of key names of tags to be removed.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_analysis_template(&self) -> UpdateAnalysisTemplateFluentBuilder
pub fn update_analysis_template(&self) -> UpdateAnalysisTemplateFluentBuilder
Constructs a fluent builder for the UpdateAnalysisTemplate
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a membership resource.
analysis_template_identifier(impl Into<String>)
/set_analysis_template_identifier(Option<String>)
:
required: trueThe identifier for the analysis template resource.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new description for the analysis template.
- On success, responds with
UpdateAnalysisTemplateOutput
with field(s):analysis_template(Option<AnalysisTemplate>)
:The analysis template.
- On failure, responds with
SdkError<UpdateAnalysisTemplateError>
Source§impl Client
impl Client
Sourcepub fn update_collaboration(&self) -> UpdateCollaborationFluentBuilder
pub fn update_collaboration(&self) -> UpdateCollaborationFluentBuilder
Constructs a fluent builder for the UpdateCollaboration
operation.
- The fluent builder is configurable:
collaboration_identifier(impl Into<String>)
/set_collaboration_identifier(Option<String>)
:
required: trueThe identifier for the collaboration.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseA human-readable identifier provided by the collaboration owner. Display names are not unique.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the collaboration.
analytics_engine(AnalyticsEngine)
/set_analytics_engine(Option<AnalyticsEngine>)
:
required: falseThe analytics engine.
After July 16, 2025, the
CLEAN_ROOMS_SQL
parameter will no longer be available.
- On success, responds with
UpdateCollaborationOutput
with field(s):collaboration(Option<Collaboration>)
:The entire collaboration that has been updated.
- On failure, responds with
SdkError<UpdateCollaborationError>
Source§impl Client
impl Client
Sourcepub fn update_configured_audience_model_association(
&self,
) -> UpdateConfiguredAudienceModelAssociationFluentBuilder
pub fn update_configured_audience_model_association( &self, ) -> UpdateConfiguredAudienceModelAssociationFluentBuilder
Constructs a fluent builder for the UpdateConfiguredAudienceModelAssociation
operation.
- The fluent builder is configurable:
configured_audience_model_association_identifier(impl Into<String>)
/set_configured_audience_model_association_identifier(Option<String>)
:
required: trueA unique identifier for the configured audience model association that you want to update.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier of the membership that contains the configured audience model association that you want to update.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new description for the configured audience model association.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseA new name for the configured audience model association.
- On success, responds with
UpdateConfiguredAudienceModelAssociationOutput
with field(s):configured_audience_model_association(Option<ConfiguredAudienceModelAssociation>)
:Details about the configured audience model association that you updated.
- On failure, responds with
SdkError<UpdateConfiguredAudienceModelAssociationError>
Source§impl Client
impl Client
Sourcepub fn update_configured_table(&self) -> UpdateConfiguredTableFluentBuilder
pub fn update_configured_table(&self) -> UpdateConfiguredTableFluentBuilder
Constructs a fluent builder for the UpdateConfiguredTable
operation.
- The fluent builder is configurable:
configured_table_identifier(impl Into<String>)
/set_configured_table_identifier(Option<String>)
:
required: trueThe identifier for the configured table to update. Currently accepts the configured table ID.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseA new name for the configured table.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new description for the configured table.
table_reference(TableReference)
/set_table_reference(Option<TableReference>)
:
required: falseA pointer to the dataset that underlies this table.
allowed_columns(impl Into<String>)
/set_allowed_columns(Option<Vec::<String>>)
:
required: falseThe columns of the underlying table that can be used by collaborations or analysis rules.
analysis_method(AnalysisMethod)
/set_analysis_method(Option<AnalysisMethod>)
:
required: falseThe analysis method for the configured table.
DIRECT_QUERY
allows SQL queries to be run directly on this table.DIRECT_JOB
allows PySpark jobs to be run directly on this table.MULTIPLE
allows both SQL queries and PySpark jobs to be run directly on this table.selected_analysis_methods(SelectedAnalysisMethod)
/set_selected_analysis_methods(Option<Vec::<SelectedAnalysisMethod>>)
:
required: falseThe selected analysis methods for the table configuration update.
- On success, responds with
UpdateConfiguredTableOutput
with field(s):configured_table(Option<ConfiguredTable>)
:The updated configured table.
- On failure, responds with
SdkError<UpdateConfiguredTableError>
Source§impl Client
impl Client
Sourcepub fn update_configured_table_analysis_rule(
&self,
) -> UpdateConfiguredTableAnalysisRuleFluentBuilder
pub fn update_configured_table_analysis_rule( &self, ) -> UpdateConfiguredTableAnalysisRuleFluentBuilder
Constructs a fluent builder for the UpdateConfiguredTableAnalysisRule
operation.
- The fluent builder is configurable:
configured_table_identifier(impl Into<String>)
/set_configured_table_identifier(Option<String>)
:
required: trueThe unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
analysis_rule_type(ConfiguredTableAnalysisRuleType)
/set_analysis_rule_type(Option<ConfiguredTableAnalysisRuleType>)
:
required: trueThe analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
analysis_rule_policy(ConfiguredTableAnalysisRulePolicy)
/set_analysis_rule_policy(Option<ConfiguredTableAnalysisRulePolicy>)
:
required: trueThe new analysis rule policy for the configured table analysis rule.
- On success, responds with
UpdateConfiguredTableAnalysisRuleOutput
with field(s):analysis_rule(Option<ConfiguredTableAnalysisRule>)
:The entire updated analysis rule.
- On failure, responds with
SdkError<UpdateConfiguredTableAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn update_configured_table_association(
&self,
) -> UpdateConfiguredTableAssociationFluentBuilder
pub fn update_configured_table_association( &self, ) -> UpdateConfiguredTableAssociationFluentBuilder
Constructs a fluent builder for the UpdateConfiguredTableAssociation
operation.
- The fluent builder is configurable:
configured_table_association_identifier(impl Into<String>)
/set_configured_table_association_identifier(Option<String>)
:
required: trueThe unique identifier for the configured table association to update. Currently accepts the configured table association ID.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique ID for the membership that the configured table association belongs to.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new description for the configured table association.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe service will assume this role to access catalog metadata and query the table.
- On success, responds with
UpdateConfiguredTableAssociationOutput
with field(s):configured_table_association(Option<ConfiguredTableAssociation>)
:The entire updated configured table association.
- On failure, responds with
SdkError<UpdateConfiguredTableAssociationError>
Source§impl Client
impl Client
Sourcepub fn update_configured_table_association_analysis_rule(
&self,
) -> UpdateConfiguredTableAssociationAnalysisRuleFluentBuilder
pub fn update_configured_table_association_analysis_rule( &self, ) -> UpdateConfiguredTableAssociationAnalysisRuleFluentBuilder
Constructs a fluent builder for the UpdateConfiguredTableAssociationAnalysisRule
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
configured_table_association_identifier(impl Into<String>)
/set_configured_table_association_identifier(Option<String>)
:
required: trueThe identifier for the configured table association to update.
analysis_rule_type(ConfiguredTableAssociationAnalysisRuleType)
/set_analysis_rule_type(Option<ConfiguredTableAssociationAnalysisRuleType>)
:
required: trueThe analysis rule type that you want to update.
analysis_rule_policy(ConfiguredTableAssociationAnalysisRulePolicy)
/set_analysis_rule_policy(Option<ConfiguredTableAssociationAnalysisRulePolicy>)
:
required: trueThe updated analysis rule policy for the configured table association.
- On success, responds with
UpdateConfiguredTableAssociationAnalysisRuleOutput
with field(s):analysis_rule(Option<ConfiguredTableAssociationAnalysisRule>)
:The updated analysis rule for the configured table association. In the console, the
ConfiguredTableAssociationAnalysisRule
is referred to as the collaboration analysis rule.
- On failure, responds with
SdkError<UpdateConfiguredTableAssociationAnalysisRuleError>
Source§impl Client
impl Client
Sourcepub fn update_id_mapping_table(&self) -> UpdateIdMappingTableFluentBuilder
pub fn update_id_mapping_table(&self) -> UpdateIdMappingTableFluentBuilder
Constructs a fluent builder for the UpdateIdMappingTable
operation.
- The fluent builder is configurable:
id_mapping_table_identifier(impl Into<String>)
/set_id_mapping_table_identifier(Option<String>)
:
required: trueThe unique identifier of the ID mapping table that you want to update.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID mapping table that you want to update.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new description for the ID mapping table.
kms_key_arn(impl Into<String>)
/set_kms_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
- On success, responds with
UpdateIdMappingTableOutput
with field(s):id_mapping_table(Option<IdMappingTable>)
:The updated ID mapping table.
- On failure, responds with
SdkError<UpdateIdMappingTableError>
Source§impl Client
impl Client
Sourcepub fn update_id_namespace_association(
&self,
) -> UpdateIdNamespaceAssociationFluentBuilder
pub fn update_id_namespace_association( &self, ) -> UpdateIdNamespaceAssociationFluentBuilder
Constructs a fluent builder for the UpdateIdNamespaceAssociation
operation.
- The fluent builder is configurable:
id_namespace_association_identifier(impl Into<String>)
/set_id_namespace_association_identifier(Option<String>)
:
required: trueThe unique identifier of the ID namespace association that you want to update.
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership that contains the ID namespace association that you want to update.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseA new name for the ID namespace association.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new description for the ID namespace association.
id_mapping_config(IdMappingConfig)
/set_id_mapping_config(Option<IdMappingConfig>)
:
required: falseThe configuration settings for the ID mapping table.
- On success, responds with
UpdateIdNamespaceAssociationOutput
with field(s):id_namespace_association(Option<IdNamespaceAssociation>)
:The updated ID namespace association.
- On failure, responds with
SdkError<UpdateIdNamespaceAssociationError>
Source§impl Client
impl Client
Sourcepub fn update_membership(&self) -> UpdateMembershipFluentBuilder
pub fn update_membership(&self) -> UpdateMembershipFluentBuilder
Constructs a fluent builder for the UpdateMembership
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe unique identifier of the membership.
query_log_status(MembershipQueryLogStatus)
/set_query_log_status(Option<MembershipQueryLogStatus>)
:
required: falseAn indicator as to whether query logging has been enabled or disabled for the membership.
When
ENABLED
, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value isDISABLED
.job_log_status(MembershipJobLogStatus)
/set_job_log_status(Option<MembershipJobLogStatus>)
:
required: falseAn indicator as to whether job logging has been enabled or disabled for the collaboration.
When
ENABLED
, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value isDISABLED
.default_result_configuration(MembershipProtectedQueryResultConfiguration)
/set_default_result_configuration(Option<MembershipProtectedQueryResultConfiguration>)
:
required: falseThe default protected query result configuration as specified by the member who can receive results.
default_job_result_configuration(MembershipProtectedJobResultConfiguration)
/set_default_job_result_configuration(Option<MembershipProtectedJobResultConfiguration>)
:
required: falseThe default job result configuration.
- On success, responds with
UpdateMembershipOutput
with field(s):membership(Option<Membership>)
:The membership object.
- On failure, responds with
SdkError<UpdateMembershipError>
Source§impl Client
impl Client
Sourcepub fn update_privacy_budget_template(
&self,
) -> UpdatePrivacyBudgetTemplateFluentBuilder
pub fn update_privacy_budget_template( &self, ) -> UpdatePrivacyBudgetTemplateFluentBuilder
Constructs a fluent builder for the UpdatePrivacyBudgetTemplate
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueA unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.
privacy_budget_template_identifier(impl Into<String>)
/set_privacy_budget_template_identifier(Option<String>)
:
required: trueA unique identifier for your privacy budget template that you want to update.
privacy_budget_type(PrivacyBudgetType)
/set_privacy_budget_type(Option<PrivacyBudgetType>)
:
required: trueSpecifies the type of the privacy budget template.
parameters(PrivacyBudgetTemplateUpdateParameters)
/set_parameters(Option<PrivacyBudgetTemplateUpdateParameters>)
:
required: falseSpecifies the epsilon and noise parameters for the privacy budget template.
- On success, responds with
UpdatePrivacyBudgetTemplateOutput
with field(s):privacy_budget_template(Option<PrivacyBudgetTemplate>)
:Summary of the privacy budget template.
- On failure, responds with
SdkError<UpdatePrivacyBudgetTemplateError>
Source§impl Client
impl Client
Sourcepub fn update_protected_job(&self) -> UpdateProtectedJobFluentBuilder
pub fn update_protected_job(&self) -> UpdateProtectedJobFluentBuilder
Constructs a fluent builder for the UpdateProtectedJob
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a member of a protected job instance.
protected_job_identifier(impl Into<String>)
/set_protected_job_identifier(Option<String>)
:
required: trueThe identifier of the protected job to update.
target_status(TargetProtectedJobStatus)
/set_target_status(Option<TargetProtectedJobStatus>)
:
required: trueThe target status of a protected job. Used to update the execution status of a currently running job.
- On success, responds with
UpdateProtectedJobOutput
with field(s):protected_job(Option<ProtectedJob>)
:The protected job output.
- On failure, responds with
SdkError<UpdateProtectedJobError>
Source§impl Client
impl Client
Sourcepub fn update_protected_query(&self) -> UpdateProtectedQueryFluentBuilder
pub fn update_protected_query(&self) -> UpdateProtectedQueryFluentBuilder
Constructs a fluent builder for the UpdateProtectedQuery
operation.
- The fluent builder is configurable:
membership_identifier(impl Into<String>)
/set_membership_identifier(Option<String>)
:
required: trueThe identifier for a member of a protected query instance.
protected_query_identifier(impl Into<String>)
/set_protected_query_identifier(Option<String>)
:
required: trueThe identifier for a protected query instance.
target_status(TargetProtectedQueryStatus)
/set_target_status(Option<TargetProtectedQueryStatus>)
:
required: trueThe target status of a query. Used to update the execution status of a currently running query.
- On success, responds with
UpdateProtectedQueryOutput
with field(s):protected_query(Option<ProtectedQuery>)
:The protected query output.
- On failure, responds with
SdkError<UpdateProtectedQueryError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);