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',
    dataSourceId='string',
    groupName='string',
    indexId='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

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

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

• groupName (string) –

  [REQUIRED]

  The name of the group.

• indexId (string) –

  [REQUIRED]

  The identifier of the index the group is attached to.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • status (dict) –

    The current status of the group.

    • errorDetail (dict) –

      The details of an error associated a group status.

      • errorCode (string) –

        The code associated with the data source sync error.

      • errorMessage (string) –

        The message explaining the data source sync error.

    • lastUpdatedAt (datetime) –

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

    • status (string) –

      The status of a group.

  • statusHistory (list) –

    The status history of the group.

    • (dict) –

      Provides the details of a group’s status.

      • errorDetail (dict) –

        The details of an error associated a group status.

        • errorCode (string) –

          The code associated with the data source sync error.

        • errorMessage (string) –

          The message explaining the data source sync error.

      • lastUpdatedAt (datetime) –

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

      • status (string) –

        The status of a group.

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ConflictException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException