2024/11/07 - AWS Clean Rooms Service - 6 updated api methods
Changes This release introduces support for Custom Models in AWS Clean Rooms ML.
{'creatorMLMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'creatorPaymentConfiguration': {'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'}}},
'members': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'}}}}}
Creates a new collaboration.
See also: AWS API Documentation
Request Syntax
client.create_collaboration(
members=[
{
'accountId': 'string',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'displayName': 'string',
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
}
}
},
],
name='string',
description='string',
creatorMemberAbilities=[
'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
],
creatorMLMemberAbilities={
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
creatorDisplayName='string',
dataEncryptionMetadata={
'allowCleartext': True|False,
'allowDuplicates': True|False,
'allowJoinsOnColumnsWithDifferentNames': True|False,
'preserveNulls': True|False
},
queryLogStatus='ENABLED'|'DISABLED',
tags={
'string': 'string'
},
creatorPaymentConfiguration={
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
}
},
analyticsEngine='SPARK'|'CLEAN_ROOMS_SQL'
)
list
[REQUIRED]
A list of initial members, not including the creator. This list is immutable.
(dict) --
Basic metadata used to construct a new member.
accountId (string) -- [REQUIRED]
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
memberAbilities (list) -- [REQUIRED]
The abilities granted to the collaboration member.
(string) --
mlMemberAbilities (dict) --
The ML abilities granted to the collaboration member.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
customMLMemberAbilities (list) -- [REQUIRED]
The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
(string) --
displayName (string) -- [REQUIRED]
The member's display name.
paymentConfiguration (dict) --
The collaboration member'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.
queryCompute (dict) -- [REQUIRED]
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
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. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
string
[REQUIRED]
The display name for a collaboration.
string
[REQUIRED]
A description of the collaboration provided by the collaboration owner.
list
[REQUIRED]
The abilities granted to the collaboration creator.
(string) --
dict
The ML abilities granted to the collaboration creator.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
customMLMemberAbilities (list) -- [REQUIRED]
The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
(string) --
string
[REQUIRED]
The display name of the collaboration creator.
dict
The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
allowCleartext (boolean) -- [REQUIRED]
Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
allowDuplicates (boolean) -- [REQUIRED]
Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
allowJoinsOnColumnsWithDifferentNames (boolean) -- [REQUIRED]
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
preserveNulls (boolean) -- [REQUIRED]
Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).
string
[REQUIRED]
An indicator as to whether query logging has been enabled or disabled for the collaboration.
dict
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
(string) --
(string) --
dict
The 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.
queryCompute (dict) -- [REQUIRED]
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
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. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
string
The analytics engine.
dict
Response Syntax
{
'collaboration': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creatorAccountId': 'string',
'creatorDisplayName': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
'membershipId': 'string',
'membershipArn': 'string',
'dataEncryptionMetadata': {
'allowCleartext': True|False,
'allowDuplicates': True|False,
'allowJoinsOnColumnsWithDifferentNames': True|False,
'preserveNulls': True|False
},
'queryLogStatus': 'ENABLED'|'DISABLED',
'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL'
}
}
Response Structure
(dict) --
collaboration (dict) --
The collaboration.
id (string) --
The unique ID for the collaboration.
arn (string) --
The unique ARN for the collaboration.
name (string) --
A human-readable identifier provided by the collaboration owner. Display names are not unique.
description (string) --
A description of the collaboration provided by the collaboration owner.
creatorAccountId (string) --
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
creatorDisplayName (string) --
A display name of the collaboration creator.
createTime (datetime) --
The time when the collaboration was created.
updateTime (datetime) --
The time the collaboration metadata was last updated.
memberStatus (string) --
The status of a member in a collaboration.
membershipId (string) --
The unique ID for your membership within the collaboration.
membershipArn (string) --
The unique ARN for your membership within the collaboration.
dataEncryptionMetadata (dict) --
The settings for client-side encryption for cryptographic computing.
allowCleartext (boolean) --
Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
allowDuplicates (boolean) --
Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
allowJoinsOnColumnsWithDifferentNames (boolean) --
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
preserveNulls (boolean) --
Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).
queryLogStatus (string) --
An indicator as to whether query logging has been enabled or disabled for the collaboration.
analyticsEngine (string) --
The analytics engine for the collaboration.
{'paymentConfiguration': {'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'}}}}
Response {'membership': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'}}}}}
Creates a membership for a specific collaboration identifier and joins the collaboration.
See also: AWS API Documentation
Request Syntax
client.create_membership(
collaborationIdentifier='string',
queryLogStatus='ENABLED'|'DISABLED',
tags={
'string': 'string'
},
defaultResultConfiguration={
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
}
},
'roleArn': 'string'
},
paymentConfiguration={
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
}
}
)
string
[REQUIRED]
The unique ID for the associated collaboration.
string
[REQUIRED]
An indicator as to whether query logging has been enabled or disabled for the membership.
dict
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
(string) --
(string) --
dict
The default protected query result configuration as specified by the member who can receive results.
outputConfiguration (dict) -- [REQUIRED]
Configuration for protected query results.
s3 (dict) --
Contains the configuration to write the query results to S3.
resultFormat (string) -- [REQUIRED]
Intended file format of the result.
bucket (string) -- [REQUIRED]
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
roleArn (string) --
The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
dict
The 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.
queryCompute (dict) -- [REQUIRED]
The payment responsibilities accepted by the collaboration member for query compute costs.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration member has accepted to pay for query compute costs ( TRUE) or has not accepted to pay for query compute costs ( FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
machineLearning (dict) --
The payment responsibilities accepted by the collaboration member for machine learning costs.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE) or has not accepted to pay for model training costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model training costs.
If you set the value to TRUE but you are not responsible to pay for model training costs.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE) or has not accepted to pay for model inference costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model inference costs.
If you set the value to TRUE but you are not responsible to pay for model inference costs.
dict
Response Syntax
{
'membership': {
'id': 'string',
'arn': 'string',
'collaborationArn': 'string',
'collaborationId': 'string',
'collaborationCreatorAccountId': 'string',
'collaborationCreatorDisplayName': 'string',
'collaborationName': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'queryLogStatus': 'ENABLED'|'DISABLED',
'defaultResultConfiguration': {
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
}
},
'roleArn': 'string'
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
}
}
}
}
Response Structure
(dict) --
membership (dict) --
The membership that was created.
id (string) --
The unique ID of the membership.
arn (string) --
The unique ARN for the membership.
collaborationArn (string) --
The unique ARN for the membership's associated collaboration.
collaborationId (string) --
The unique ID for the membership's collaboration.
collaborationCreatorAccountId (string) --
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
collaborationCreatorDisplayName (string) --
The display name of the collaboration creator.
collaborationName (string) --
The name of the membership's collaboration.
createTime (datetime) --
The time when the membership was created.
updateTime (datetime) --
The time the membership metadata was last updated.
status (string) --
The status of the membership.
memberAbilities (list) --
The abilities granted to the collaboration member.
(string) --
mlMemberAbilities (dict) --
Specifies the ML member abilities that are granted to a collaboration member.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
(string) --
queryLogStatus (string) --
An indicator as to whether query logging has been enabled or disabled for the membership.
defaultResultConfiguration (dict) --
The default protected query result configuration as specified by the member who can receive results.
outputConfiguration (dict) --
Configuration for protected query results.
s3 (dict) --
Contains the configuration to write the query results to S3.
resultFormat (string) --
Intended file format of the result.
bucket (string) --
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
roleArn (string) --
The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
paymentConfiguration (dict) --
The payment responsibilities accepted by the collaboration member.
queryCompute (dict) --
The payment responsibilities accepted by the collaboration member for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for query compute costs ( TRUE) or has not accepted to pay for query compute costs ( FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
machineLearning (dict) --
The payment responsibilities accepted by the collaboration member for machine learning costs.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE) or has not accepted to pay for model training costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model training costs.
If you set the value to TRUE but you are not responsible to pay for model training costs.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE) or has not accepted to pay for model inference costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model inference costs.
If you set the value to TRUE but you are not responsible to pay for model inference costs.
{'membership': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'}}}}}
Retrieves a specified membership for an identifier.
See also: AWS API Documentation
Request Syntax
client.get_membership(
membershipIdentifier='string'
)
string
[REQUIRED]
The identifier for a membership resource.
dict
Response Syntax
{
'membership': {
'id': 'string',
'arn': 'string',
'collaborationArn': 'string',
'collaborationId': 'string',
'collaborationCreatorAccountId': 'string',
'collaborationCreatorDisplayName': 'string',
'collaborationName': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'queryLogStatus': 'ENABLED'|'DISABLED',
'defaultResultConfiguration': {
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
}
},
'roleArn': 'string'
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
}
}
}
}
Response Structure
(dict) --
membership (dict) --
The membership retrieved for the provided identifier.
id (string) --
The unique ID of the membership.
arn (string) --
The unique ARN for the membership.
collaborationArn (string) --
The unique ARN for the membership's associated collaboration.
collaborationId (string) --
The unique ID for the membership's collaboration.
collaborationCreatorAccountId (string) --
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
collaborationCreatorDisplayName (string) --
The display name of the collaboration creator.
collaborationName (string) --
The name of the membership's collaboration.
createTime (datetime) --
The time when the membership was created.
updateTime (datetime) --
The time the membership metadata was last updated.
status (string) --
The status of the membership.
memberAbilities (list) --
The abilities granted to the collaboration member.
(string) --
mlMemberAbilities (dict) --
Specifies the ML member abilities that are granted to a collaboration member.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
(string) --
queryLogStatus (string) --
An indicator as to whether query logging has been enabled or disabled for the membership.
defaultResultConfiguration (dict) --
The default protected query result configuration as specified by the member who can receive results.
outputConfiguration (dict) --
Configuration for protected query results.
s3 (dict) --
Contains the configuration to write the query results to S3.
resultFormat (string) --
Intended file format of the result.
bucket (string) --
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
roleArn (string) --
The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
paymentConfiguration (dict) --
The payment responsibilities accepted by the collaboration member.
queryCompute (dict) --
The payment responsibilities accepted by the collaboration member for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for query compute costs ( TRUE) or has not accepted to pay for query compute costs ( FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
machineLearning (dict) --
The payment responsibilities accepted by the collaboration member for machine learning costs.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE) or has not accepted to pay for model training costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model training costs.
If you set the value to TRUE but you are not responsible to pay for model training costs.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE) or has not accepted to pay for model inference costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model inference costs.
If you set the value to TRUE but you are not responsible to pay for model inference costs.
{'memberSummaries': {'mlAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'}}}}}
Lists all members within a collaboration.
See also: AWS API Documentation
Request Syntax
client.list_members(
collaborationIdentifier='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier of the collaboration in which the members are listed.
string
The pagination token that's used to fetch the next set of results.
integer
The 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 the maxResults value has not been met.
dict
Response Syntax
{
'nextToken': 'string',
'memberSummaries': [
{
'accountId': 'string',
'status': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
'displayName': 'string',
'abilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
],
'mlAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'membershipId': 'string',
'membershipArn': 'string',
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
}
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token that's used to fetch the next set of results.
memberSummaries (list) --
The list of members returned by the ListMembers operation.
(dict) --
The member object listed by the request.
accountId (string) --
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
status (string) --
The status of the member.
displayName (string) --
The member's display name.
abilities (list) --
The abilities granted to the collaboration member.
(string) --
mlAbilities (dict) --
Provides a summary of the ML abilities for the collaboration member.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
(string) --
createTime (datetime) --
The time when the member was created.
updateTime (datetime) --
The time the member metadata was last updated.
membershipId (string) --
The unique ID for the member's associated membership, if present.
membershipArn (string) --
The unique ARN for the member's associated membership, if present.
paymentConfiguration (dict) --
The collaboration member's payment responsibilities set by the collaboration creator.
queryCompute (dict) --
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
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. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
{'membershipSummaries': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'}}}}}
Lists all memberships resources within the caller's account.
See also: AWS API Documentation
Request Syntax
client.list_memberships(
nextToken='string',
maxResults=123,
status='ACTIVE'|'REMOVED'|'COLLABORATION_DELETED'
)
string
The pagination token that's used to fetch the next set of results.
integer
The 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 the maxResults value has not been met.
string
A filter which will return only memberships in the specified status.
dict
Response Syntax
{
'nextToken': 'string',
'membershipSummaries': [
{
'id': 'string',
'arn': 'string',
'collaborationArn': 'string',
'collaborationId': 'string',
'collaborationCreatorAccountId': 'string',
'collaborationCreatorDisplayName': 'string',
'collaborationName': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
}
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token that's used to fetch the next set of results.
membershipSummaries (list) --
The list of memberships returned from the ListMemberships operation.
(dict) --
The membership object listed by the request.
id (string) --
The unique ID for the membership's collaboration.
arn (string) --
The unique ARN for the membership.
collaborationArn (string) --
The unique ARN for the membership's associated collaboration.
collaborationId (string) --
The unique ID for the membership's collaboration.
collaborationCreatorAccountId (string) --
The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.
collaborationCreatorDisplayName (string) --
The display name of the collaboration creator.
collaborationName (string) --
The name for the membership's collaboration.
createTime (datetime) --
The time when the membership was created.
updateTime (datetime) --
The time the membership metadata was last updated.
status (string) --
The status of the membership.
memberAbilities (list) --
The abilities granted to the collaboration member.
(string) --
mlMemberAbilities (dict) --
Provides a summary of the ML abilities for the collaboration member.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
(string) --
paymentConfiguration (dict) --
The payment responsibilities accepted by the collaboration member.
queryCompute (dict) --
The payment responsibilities accepted by the collaboration member for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for query compute costs ( TRUE) or has not accepted to pay for query compute costs ( FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
machineLearning (dict) --
The payment responsibilities accepted by the collaboration member for machine learning costs.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE) or has not accepted to pay for model training costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model training costs.
If you set the value to TRUE but you are not responsible to pay for model training costs.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE) or has not accepted to pay for model inference costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model inference costs.
If you set the value to TRUE but you are not responsible to pay for model inference costs.
{'membership': {'mlMemberAbilities': {'customMLMemberAbilities': ['CAN_RECEIVE_MODEL_OUTPUT '
'| '
'CAN_RECEIVE_INFERENCE_OUTPUT']},
'paymentConfiguration': {'machineLearning': {'modelInference': {'isResponsible': 'boolean'},
'modelTraining': {'isResponsible': 'boolean'}}}}}
Updates a membership.
See also: AWS API Documentation
Request Syntax
client.update_membership(
membershipIdentifier='string',
queryLogStatus='ENABLED'|'DISABLED',
defaultResultConfiguration={
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
}
},
'roleArn': 'string'
}
)
string
[REQUIRED]
The unique identifier of the membership.
string
An indicator as to whether query logging has been enabled or disabled for the membership.
dict
The default protected query result configuration as specified by the member who can receive results.
outputConfiguration (dict) -- [REQUIRED]
Configuration for protected query results.
s3 (dict) --
Contains the configuration to write the query results to S3.
resultFormat (string) -- [REQUIRED]
Intended file format of the result.
bucket (string) -- [REQUIRED]
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
roleArn (string) --
The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
dict
Response Syntax
{
'membership': {
'id': 'string',
'arn': 'string',
'collaborationArn': 'string',
'collaborationId': 'string',
'collaborationCreatorAccountId': 'string',
'collaborationCreatorDisplayName': 'string',
'collaborationName': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'status': 'ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'queryLogStatus': 'ENABLED'|'DISABLED',
'defaultResultConfiguration': {
'outputConfiguration': {
's3': {
'resultFormat': 'CSV'|'PARQUET',
'bucket': 'string',
'keyPrefix': 'string',
'singleFileOutput': True|False
}
},
'roleArn': 'string'
},
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
}
}
}
}
Response Structure
(dict) --
membership (dict) --
The membership object.
id (string) --
The unique ID of the membership.
arn (string) --
The unique ARN for the membership.
collaborationArn (string) --
The unique ARN for the membership's associated collaboration.
collaborationId (string) --
The unique ID for the membership's collaboration.
collaborationCreatorAccountId (string) --
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
collaborationCreatorDisplayName (string) --
The display name of the collaboration creator.
collaborationName (string) --
The name of the membership's collaboration.
createTime (datetime) --
The time when the membership was created.
updateTime (datetime) --
The time the membership metadata was last updated.
status (string) --
The status of the membership.
memberAbilities (list) --
The abilities granted to the collaboration member.
(string) --
mlMemberAbilities (dict) --
Specifies the ML member abilities that are granted to a collaboration member.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
customMLMemberAbilities (list) --
The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.
Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.
(string) --
queryLogStatus (string) --
An indicator as to whether query logging has been enabled or disabled for the membership.
defaultResultConfiguration (dict) --
The default protected query result configuration as specified by the member who can receive results.
outputConfiguration (dict) --
Configuration for protected query results.
s3 (dict) --
Contains the configuration to write the query results to S3.
resultFormat (string) --
Intended file format of the result.
bucket (string) --
The S3 bucket to unload the protected query results.
keyPrefix (string) --
The S3 prefix to unload the protected query results.
singleFileOutput (boolean) --
Indicates whether files should be output as a single file ( TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.
roleArn (string) --
The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
paymentConfiguration (dict) --
The payment responsibilities accepted by the collaboration member.
queryCompute (dict) --
The payment responsibilities accepted by the collaboration member for query compute costs.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for query compute costs ( TRUE) or has not accepted to pay for query compute costs ( FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
machineLearning (dict) --
The payment responsibilities accepted by the collaboration member for machine learning costs.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE) or has not accepted to pay for model training costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model training costs.
If you set the value to TRUE but you are not responsible to pay for model training costs.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) --
Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE) or has not accepted to pay for model inference costs ( FALSE).
If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model inference costs.
If you set the value to TRUE but you are not responsible to pay for model inference costs.