AWS Control Tower

Resets an enabled control.

See also: AWS API Documentation

Request Syntax

client.reset_enabled_control(
    enabledControlIdentifier='string'
)

type enabledControlIdentifier:

string

param enabledControlIdentifier:

[REQUIRED]

The ARN of the enabled control to be reset.

rtype:

dict

returns:

Response Syntax

{
    'operationIdentifier': 'string'
}

Response Structure

• (dict) --

  • operationIdentifier (string) --

    The operation identifier for this ResetEnabledControl operation.

{'controlOperation': {'operationType': {'RESET_ENABLED_CONTROL'}}}

Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide.

See also: AWS API Documentation

Request Syntax

client.get_control_operation(
    operationIdentifier='string'
)

type operationIdentifier:

string

param operationIdentifier:

[REQUIRED]

The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

rtype:

dict

returns:

Response Syntax

{
    'controlOperation': {
        'controlIdentifier': 'string',
        'enabledControlIdentifier': 'string',
        'endTime': datetime(2015, 1, 1),
        'operationIdentifier': 'string',
        'operationType': 'ENABLE_CONTROL'|'DISABLE_CONTROL'|'UPDATE_ENABLED_CONTROL'|'RESET_ENABLED_CONTROL',
        'startTime': datetime(2015, 1, 1),
        'status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
        'statusMessage': 'string',
        'targetIdentifier': 'string'
    }
}

Response Structure

• (dict) --

  • controlOperation (dict) --

    An operation performed by the control.

    • controlIdentifier (string) --

      The controlIdentifier of the control for the operation.

    • enabledControlIdentifier (string) --

      The controlIdentifier of the enabled control.

    • endTime (datetime) --

      The time that the operation finished.

    • operationIdentifier (string) --

      The identifier of the specified operation.

    • operationType (string) --

      One of ENABLE_CONTROL or DISABLE_CONTROL.

    • startTime (datetime) --

      The time that the operation began.

    • status (string) --

      One of IN_PROGRESS, SUCEEDED, or FAILED.

    • statusMessage (string) --

      If the operation result is FAILED, this string contains a message explaining why the operation failed.

    • targetIdentifier (string) --

      The target upon which the control operation is working.

{'filter': {'controlOperationTypes': {'RESET_ENABLED_CONTROL'}}}

{'controlOperations': {'operationType': {'RESET_ENABLED_CONTROL'}}}

Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.

See also: AWS API Documentation

Request Syntax

client.list_control_operations(
    filter={
        'controlIdentifiers': [
            'string',
        ],
        'controlOperationTypes': [
            'ENABLE_CONTROL'|'DISABLE_CONTROL'|'UPDATE_ENABLED_CONTROL'|'RESET_ENABLED_CONTROL',
        ],
        'enabledControlIdentifiers': [
            'string',
        ],
        'statuses': [
            'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
        ],
        'targetIdentifiers': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)

type filter:

dict

param filter:

An input filter for the ListControlOperations API that lets you select the types of control operations to view.

• controlIdentifiers (list) --

  The set of controlIdentifier returned by the filter.

  • (string) --

• controlOperationTypes (list) --

  The set of ControlOperation objects returned by the filter.

  • (string) --

• enabledControlIdentifiers (list) --

  The set controlIdentifier of enabled controls selected by the filter.

  • (string) --

• statuses (list) --

  Lists the status of control operations.

  • (string) --

• targetIdentifiers (list) --

  The set of targetIdentifier objects returned by the filter.

  • (string) --

type maxResults:

integer

param maxResults:

The maximum number of results to be shown.

type nextToken:

string

param nextToken:

A pagination token.

rtype:

dict

returns:

Response Syntax

{
    'controlOperations': [
        {
            'controlIdentifier': 'string',
            'enabledControlIdentifier': 'string',
            'endTime': datetime(2015, 1, 1),
            'operationIdentifier': 'string',
            'operationType': 'ENABLE_CONTROL'|'DISABLE_CONTROL'|'UPDATE_ENABLED_CONTROL'|'RESET_ENABLED_CONTROL',
            'startTime': datetime(2015, 1, 1),
            'status': 'SUCCEEDED'|'FAILED'|'IN_PROGRESS',
            'statusMessage': 'string',
            'targetIdentifier': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • controlOperations (list) --

    Returns a list of output from control operations.

    • (dict) --

      A summary of information about the specified control operation.

      • controlIdentifier (string) --

        The controlIdentifier of a control.

      • enabledControlIdentifier (string) --

        The controlIdentifier of an enabled control.

      • endTime (datetime) --

        The time at which the control operation was completed.

      • operationIdentifier (string) --

        The unique identifier of a control operation.

      • operationType (string) --

        The type of operation.

      • startTime (datetime) --

        The time at which a control operation began.

      • status (string) --

        The status of the specified control operation.

      • statusMessage (string) --

        A speficic message displayed as part of the control status.

      • targetIdentifier (string) --

        The unique identifier of the target of a control operation.

  • nextToken (string) --

    A pagination token.