WorkSpaces / Paginator / DescribeAccountModifications

DescribeAccountModifications

class WorkSpaces.Paginator.DescribeAccountModifications

paginator = client.get_paginator('describe_account_modifications')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_account_modifications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'AccountModifications': [
        {
            'ModificationState': 'PENDING'|'COMPLETED'|'FAILED',
            'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
            'DedicatedTenancyManagementCidrRange': 'string',
            'StartTime': datetime(2015, 1, 1),
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • AccountModifications (list) –

    The list of modifications to the configuration of BYOL.

    • (dict) –

      Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.

      • ModificationState (string) –

        The state of the modification to the configuration of BYOL.

      • DedicatedTenancySupport (string) –

        The status of BYOL (whether BYOL is being enabled or disabled).

      • DedicatedTenancyManagementCidrRange (string) –

        The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.

      • StartTime (datetime) –

        The timestamp when the modification of the BYOL configuration was started.

      • ErrorCode (string) –

        The error code that is returned if the configuration of BYOL cannot be modified.

      • ErrorMessage (string) –

        The text of the error message that is returned if the configuration of BYOL cannot be modified.