Alexa For Business

2018/05/07 - Alexa For Business - 3 updated api methods

Changes  Update alexaforbusiness client to latest version

GetDevice (updated) Link ¶
Changes (response) 
{'Device': {'DeviceStatus': {'DEREGISTERED'}}}

Gets the details of a device by device ARN.

See also: AWS API Documentation

Request Syntax

client.get_device(
    DeviceArn='string'
)
type DeviceArn:

string

param DeviceArn:

The ARN of the device for which to request details. Required.

rtype:

dict

returns:

Response Syntax

{
    'Device': {
        'DeviceArn': 'string',
        'DeviceSerialNumber': 'string',
        'DeviceType': 'string',
        'DeviceName': 'string',
        'SoftwareVersion': 'string',
        'MacAddress': 'string',
        'RoomArn': 'string',
        'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED',
        'DeviceStatusInfo': {
            'DeviceStatusDetails': [
                {
                    'Code': 'DEVICE_SOFTWARE_UPDATE_NEEDED'|'DEVICE_WAS_OFFLINE'
                },
            ],
            'ConnectionStatus': 'ONLINE'|'OFFLINE'
        }
    }
}

Response Structure

  • (dict) --

    • Device (dict) --

      The details of the device requested. Required.

      • DeviceArn (string) --

        The ARN of a device.

      • DeviceSerialNumber (string) --

        The serial number of a device.

      • DeviceType (string) --

        The type of a device.

      • DeviceName (string) --

        The name of a device.

      • SoftwareVersion (string) --

        The software version of a device.

      • MacAddress (string) --

        The MAC address of a device.

      • RoomArn (string) --

        The room ARN of a device.

      • DeviceStatus (string) --

        The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.

      • DeviceStatusInfo (dict) --

        Detailed information about a device's status.

        • DeviceStatusDetails (list) --

          One or more device status detail descriptions.

          • (dict) --

            Details of a device’s status.

            • Code (string) --

              The device status detail code.

        • ConnectionStatus (string) --

          The latest available information about the connection status of a device.

ListDeviceEvents (updated) Link ¶
Changes (request, response)
Request 
{'EventType': {'DEVICE_STATUS'}}
Response 
{'DeviceEvents': {'Type': {'DEVICE_STATUS'}}}

Lists the Device Event history for up to 30 days. If EventType isn't specified in the request, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

See also: AWS API Documentation

Request Syntax

client.list_device_events(
    DeviceArn='string',
    EventType='CONNECTION_STATUS'|'DEVICE_STATUS',
    NextToken='string',
    MaxResults=123
)
type DeviceArn:

string

param DeviceArn:

[REQUIRED]

The ARN of a device.

type EventType:

string

param EventType:

The event type to filter device events.

type NextToken:

string

param NextToken:

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

type MaxResults:

integer

param MaxResults:

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

rtype:

dict

returns:

Response Syntax

{
    'DeviceEvents': [
        {
            'Type': 'CONNECTION_STATUS'|'DEVICE_STATUS',
            'Value': 'string',
            'Timestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DeviceEvents (list) --

      • (dict) --

        The list of device events.

        • Type (string) --

          The type of device event.

        • Value (string) --

          The value of the event.

        • Timestamp (datetime) --

          The time (in epoch) when the event occurred.

    • NextToken (string) --

SearchDevices (updated) Link ¶
Changes (response) 
{'Devices': {'DeviceStatus': {'DEREGISTERED'}}}

Searches devices and lists the ones that meet a set of filter criteria.

See also: AWS API Documentation

Request Syntax

client.search_devices(
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ]
)
type NextToken:

string

param NextToken:

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

type MaxResults:

integer

param MaxResults:

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

type Filters:

list

param Filters:

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

    • Key (string) -- [REQUIRED]

      The key of a filter.

    • Values (list) -- [REQUIRED]

      The values of a filter.

      • (string) --

type SortCriteria:

list

param SortCriteria:

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.

  • (dict) --

    An object representing a sort criteria.

    • Key (string) -- [REQUIRED]

      The sort key of a sort object.

    • Value (string) -- [REQUIRED]

      The sort value of a sort object.

rtype:

dict

returns:

Response Syntax

{
    'Devices': [
        {
            'DeviceArn': 'string',
            'DeviceSerialNumber': 'string',
            'DeviceType': 'string',
            'DeviceName': 'string',
            'SoftwareVersion': 'string',
            'MacAddress': 'string',
            'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED',
            'RoomArn': 'string',
            'RoomName': 'string',
            'DeviceStatusInfo': {
                'DeviceStatusDetails': [
                    {
                        'Code': 'DEVICE_SOFTWARE_UPDATE_NEEDED'|'DEVICE_WAS_OFFLINE'
                    },
                ],
                'ConnectionStatus': 'ONLINE'|'OFFLINE'
            }
        },
    ],
    'NextToken': 'string',
    'TotalCount': 123
}

Response Structure

  • (dict) --

    • Devices (list) --

      The devices that meet the specified set of filter criteria, in sort order.

      • (dict) --

        Device attributes.

        • DeviceArn (string) --

          The ARN of a device.

        • DeviceSerialNumber (string) --

          The serial number of a device.

        • DeviceType (string) --

          The type of a device.

        • DeviceName (string) --

          The name of a device.

        • SoftwareVersion (string) --

          The software version of a device.

        • MacAddress (string) --

          The MAC address of a device.

        • DeviceStatus (string) --

          The status of a device.

        • RoomArn (string) --

          The room ARN associated with a device.

        • RoomName (string) --

          The name of the room associated with a device.

        • DeviceStatusInfo (dict) --

          Detailed information about a device's status.

          • DeviceStatusDetails (list) --

            One or more device status detail descriptions.

            • (dict) --

              Details of a device’s status.

              • Code (string) --

                The device status detail code.

          • ConnectionStatus (string) --

            The latest available information about the connection status of a device.

    • NextToken (string) --

      The token returned to indicate that there is more data available.

    • TotalCount (integer) --

      The total number of devices returned.