batch_create_channel_membership

batch_create_channel_membership(**kwargs)

Adds a specified number of users to a channel.

See also: AWS API Documentation

Request Syntax

response = client.batch_create_channel_membership(
    ChannelArn='string',
    Type='DEFAULT'|'HIDDEN',
    MemberArns=[
        'string',
    ],
    ChimeBearer='string',
    SubChannelId='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 AppInstanceUserArn s of the members you want to add to the channel.

    • (string) --
  • ChimeBearer (string) --

    [REQUIRED]

    The AppInstanceUserArn of the user that makes the API call.

  • SubChannelId (string) --

    The ID of the SubChannel in the request.

    Note

    Only required when creating membership in a SubChannel for a moderator in an elastic channel.

Return type

dict

Returns

Response Syntax

{
    'BatchChannelMemberships': {
        'InvitedBy': {
            'Arn': 'string',
            'Name': 'string'
        },
        'Type': 'DEFAULT'|'HIDDEN',
        'Members': [
            {
                'Arn': 'string',
                'Name': 'string'
            },
        ],
        'ChannelArn': 'string',
        'SubChannelId': '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.

      • SubChannelId (string) --

        The ID of the SubChannel.

    • 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 AppInstanceUserArn of the member that the service couldn't add.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException
  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException
  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException
  • ChimeSDKMessaging.Client.exceptions.BadRequestException
  • ChimeSDKMessaging.Client.exceptions.NotFoundException
  • ChimeSDKMessaging.Client.exceptions.ForbiddenException
  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException
  • ChimeSDKMessaging.Client.exceptions.ResourceLimitExceededException