Private5G / Client / deactivate_device_identifier

deactivate_device_identifier#

Private5G.Client.deactivate_device_identifier(**kwargs)#

Deactivates the specified device identifier.

See also: AWS API Documentation

Request Syntax

response = client.deactivate_device_identifier(
    clientToken='string',
    deviceIdentifierArn='string'
)
Parameters:

  • clientToken (string) – Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • deviceIdentifierArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the device identifier.

Return type:

dict

Returns:

Response Syntax

{
    'deviceIdentifier': {
        'createdAt': datetime(2015, 1, 1),
        'deviceIdentifierArn': 'string',
        'iccid': 'string',
        'imsi': 'string',
        'networkArn': 'string',
        'orderArn': 'string',
        'status': 'ACTIVE'|'INACTIVE',
        'trafficGroupArn': 'string',
        'vendor': 'string'
    }
}

Response Structure

  • (dict) –

    • deviceIdentifier (dict) –

      Information about the device identifier.

      • createdAt (datetime) –

        The creation time of this device identifier.

      • deviceIdentifierArn (string) –

        The Amazon Resource Name (ARN) of the device identifier.

      • iccid (string) –

        The Integrated Circuit Card Identifier of the device identifier.

      • imsi (string) –

        The International Mobile Subscriber Identity of the device identifier.

      • networkArn (string) –

        The Amazon Resource Name (ARN) of the network on which the device identifier appears.

      • orderArn (string) –

        The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

      • status (string) –

        The status of the device identifier.

      • trafficGroupArn (string) –

        The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

      • vendor (string) –

        The vendor of the device identifier.

Exceptions

  • Private5G.Client.exceptions.ResourceNotFoundException

  • Private5G.Client.exceptions.ValidationException

  • Private5G.Client.exceptions.InternalServerException