LookoutEquipment / Client / list_label_groups

list_label_groups#

LookoutEquipment.Client.list_label_groups(**kwargs)#

Returns a list of the label groups.

See also: AWS API Documentation

Request Syntax

response = client.list_label_groups(
    LabelGroupNameBeginsWith='string',
    NextToken='string',
    MaxResults=123
)
Parameters:
  • LabelGroupNameBeginsWith (string) – The beginning of the name of the label groups to be listed.

  • NextToken (string) – An opaque pagination token indicating where to continue the listing of label groups.

  • MaxResults (integer) – Specifies the maximum number of label groups to list.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'LabelGroupSummaries': [
        {
            'LabelGroupName': 'string',
            'LabelGroupArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      An opaque pagination token indicating where to continue the listing of label groups.

    • LabelGroupSummaries (list) –

      A summary of the label groups.

      • (dict) –

        Contains information about the label group.

        • LabelGroupName (string) –

          The name of the label group.

        • LabelGroupArn (string) –

          The Amazon Resource Name (ARN) of the label group.

        • CreatedAt (datetime) –

          The time at which the label group was created.

        • UpdatedAt (datetime) –

          The time at which the label group was updated.

Exceptions

  • LookoutEquipment.Client.exceptions.ValidationException

  • LookoutEquipment.Client.exceptions.ThrottlingException

  • LookoutEquipment.Client.exceptions.AccessDeniedException

  • LookoutEquipment.Client.exceptions.InternalServerException