Skip to content

create_group async

create_group(
    group_name: GroupName,
    aws_account_id: AwsAccountId,
    namespace: Namespace,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    description: Optional[GroupDescription] = None,
) -> CreateGroupResponse

Use the CreateGroup operation to create a group in Quick Sight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.

The permissions resource is arn:aws:quicksight:::group/default/ .

The response is a group object.

Parameters:

  • group_name (GroupName) –

    A name for the group that you want to create.

  • description (Optional[GroupDescription], default: None ) –

    A description for the group that you want to create.

  • aws_account_id (AwsAccountId) –

    The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.

  • namespace (Namespace) –

    The namespace that you want the group to be a part of.

Raises:

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py
async def create_group(
    self,
    group_name: "capo_quicksight.types.group_name.GroupName",
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    namespace: "capo_quicksight.types.namespace.Namespace",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    description: Optional[
        "capo_quicksight.types.group_description.GroupDescription"
    ] = None,
) -> "capo_quicksight.types.create_group_response.CreateGroupResponse":
    """<p>Use the <code>CreateGroup</code> operation to create a group in Quick Sight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.</p> <p>The permissions resource is <code>arn:aws:quicksight:<your-region>:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i> </code>.</p> <p>The response is a group object.</p>

    Args:
        group_name: <p>A name for the group that you want to create.</p>
        description: <p>A description for the group that you want to create.</p>
        aws_account_id: <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.</p>
        namespace: <p>The namespace that you want the group to be a part of.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.limit_exceeded_exception.LimitExceededException: <p>A limit is exceeded.</p>
        capo_quicksight.errors.precondition_not_met_exception.PreconditionNotMetException: <p>One or more preconditions aren't met.</p>
        capo_quicksight.errors.resource_exists_exception.ResourceExistsException: <p>The resource specified already exists. </p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.resource_unavailable_exception.ResourceUnavailableException: <p>This resource is currently unavailable.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.create_group_request.CreateGroupRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.create_group_response.CreateGroupResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.create_group

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.create_group.async_create_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateGroup")
    )
    input_: capo_quicksight.types.create_group_request.CreateGroupRequest = {
        "group_name": group_name,
        "aws_account_id": aws_account_id,
        "namespace": namespace,
    }
    if description is not None:
        input_["description"] = description

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output