Chime / Client / batch_create_channel_membership

batch_create_channel_membership#

Chime.Client.batch_create_channel_membership(**kwargs)#

Adds a specified number of users to a channel.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, BatchCreateChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

response = client.batch_create_channel_membership(
    ChannelArn='string',
    Type='DEFAULT'|'HIDDEN',
    MemberArns=[
        'string',
    ],
    ChimeBearer='string'
)

Parameters:

ChannelArn (string) –
[REQUIRED]

The ARN of the channel to which you’re adding users.
Type (string) – The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
MemberArns (list) –
[REQUIRED]

The ARNs of the members you want to add to the channel.
- (string) –
ChimeBearer (string) – The AppInstanceUserArn of the user that makes the API call.

Return type:

dict

Returns:

Response Syntax

{
    'BatchChannelMemberships': {
        'InvitedBy': {
            'Arn': 'string',
            'Name': 'string'
        },
        'Type': 'DEFAULT'|'HIDDEN',
        'Members': [
            {
                'Arn': 'string',
                'Name': 'string'
            },
        ],
        'ChannelArn': 'string'
    },
    'Errors': [
        {
            'MemberArn': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) –
- BatchChannelMemberships (dict) –
  
  The list of channel memberships in the response.
  - InvitedBy (dict) –
    
    The identifier of the member who invited another member.
    - Arn (string) –
      
      The ARN in an Identity.
    - Name (string) –
      
      The name in an Identity.
  - Type (string) –
    
    The membership types set for the channel users.
  - Members (list) –
    
    The users successfully added to the request.
    - (dict) –
      
      The details of a user.
      - Arn (string) –
        
        The ARN in an Identity.
      - Name (string) –
        
        The name in an Identity.
  - ChannelArn (string) –
    
    The ARN of the channel to which you’re adding users.
- Errors (list) –
  
  If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.
  - (dict) –
    
    A list of failed member ARNs, error codes, and error messages.
    - MemberArn (string) –
      
      The ARN of the member that the service couldn’t add.
    - ErrorCode (string) –
      
      The error code.
    - ErrorMessage (string) –
      
      The error message.

Exceptions

Chime.Client.exceptions.ServiceFailureException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.ThrottledClientException