QBusiness / Client / get_group

get_group#

QBusiness.Client.get_group(**kwargs)#

Describes a group by group name.

See also: AWS API Documentation

Request Syntax

response = client.get_group(
    applicationId='string',
    indexId='string',
    groupName='string',
    dataSourceId='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the application id the group is attached to.

  • indexId (string) –

    [REQUIRED]

    The identifier of the index the group is attached to.

  • groupName (string) –

    [REQUIRED]

    The name of the group.

  • dataSourceId (string) – The identifier of the data source the group is attached to.

Return type:

dict

Returns:

Response Syntax

{
    'status': {
        'status': 'FAILED'|'SUCCEEDED'|'PROCESSING'|'DELETING'|'DELETED',
        'lastUpdatedAt': datetime(2015, 1, 1),
        'errorDetail': {
            'errorMessage': 'string',
            'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
        }
    },
    'statusHistory': [
        {
            'status': 'FAILED'|'SUCCEEDED'|'PROCESSING'|'DELETING'|'DELETED',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'errorDetail': {
                'errorMessage': 'string',
                'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • status (dict) –

      The current status of the group.

      • status (string) –

        The status of a group.

      • lastUpdatedAt (datetime) –

        The Unix timestamp when the Amazon Q Business application was last updated.

      • errorDetail (dict) –

        The details of an error associated a group status.

        • errorMessage (string) –

          The message explaining the data source sync error.

        • errorCode (string) –

          The code associated with the data source sync error.

    • statusHistory (list) –

      The status history of the group.

      • (dict) –

        Provides the details of a group’s status.

        • status (string) –

          The status of a group.

        • lastUpdatedAt (datetime) –

          The Unix timestamp when the Amazon Q Business application was last updated.

        • errorDetail (dict) –

          The details of an error associated a group status.

          • errorMessage (string) –

            The message explaining the data source sync error.

          • errorCode (string) –

            The code associated with the data source sync error.

Exceptions