DirectoryService / Client / describe_hybrid_ad_update

describe_hybrid_ad_update

DirectoryService.Client.describe_hybrid_ad_update(**kwargs)

Retrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account updates, and self-managed instance settings (IDs and DNS IPs).

See also: AWS API Documentation

Request Syntax

response = client.describe_hybrid_ad_update(
    DirectoryId='string',
    UpdateType='SelfManagedInstances'|'HybridAdministratorAccount',
    NextToken='string'
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The identifier of the hybrid directory for which to retrieve update information.

  • UpdateType (string) – The type of update activities to retrieve. Valid values include SelfManagedInstances and HybridAdministratorAccount.

  • NextToken (string) – The pagination token from a previous request to DescribeHybridADUpdate. Pass null if this is the first request.

Return type:

dict

Returns:

Response Syntax

{
    'UpdateActivities': {
        'SelfManagedInstances': [
            {
                'Status': 'Updated'|'Updating'|'UpdateFailed',
                'StatusReason': 'string',
                'InitiatedBy': 'string',
                'NewValue': {
                    'InstanceIds': [
                        'string',
                    ],
                    'DnsIps': [
                        'string',
                    ]
                },
                'PreviousValue': {
                    'InstanceIds': [
                        'string',
                    ],
                    'DnsIps': [
                        'string',
                    ]
                },
                'StartTime': datetime(2015, 1, 1),
                'LastUpdatedDateTime': datetime(2015, 1, 1),
                'AssessmentId': 'string'
            },
        ],
        'HybridAdministratorAccount': [
            {
                'Status': 'Updated'|'Updating'|'UpdateFailed',
                'StatusReason': 'string',
                'InitiatedBy': 'string',
                'NewValue': {
                    'InstanceIds': [
                        'string',
                    ],
                    'DnsIps': [
                        'string',
                    ]
                },
                'PreviousValue': {
                    'InstanceIds': [
                        'string',
                    ],
                    'DnsIps': [
                        'string',
                    ]
                },
                'StartTime': datetime(2015, 1, 1),
                'LastUpdatedDateTime': datetime(2015, 1, 1),
                'AssessmentId': 'string'
            },
        ]
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • UpdateActivities (dict) –

      Information about update activities for the hybrid directory, organized by update type.

      • SelfManagedInstances (list) –

        A list of update activities related to the self-managed instances with SSM in the self-managed instances with SSM hybrid directory configuration.

        • (dict) –

          Contains detailed information about a specific update activity for a hybrid directory component.

          • Status (string) –

            The current status of the update activity. Valid values include UPDATED, UPDATING, and UPDATE_FAILED.

          • StatusReason (string) –

            A human-readable description of the update status, including any error details or progress information.

          • InitiatedBy (string) –

            Specifies if the update was initiated by the customer or Amazon Web Services.

          • NewValue (dict) –

            The new configuration values being applied in this update.

            • InstanceIds (list) –

              The identifiers of the self-managed instances with SSM in the hybrid directory configuration.

              • (string) –

            • DnsIps (list) –

              The IP addresses of the DNS servers or domain controllers in the hybrid directory configuration.

              • (string) –

          • PreviousValue (dict) –

            The previous configuration values before this update was applied.

            • InstanceIds (list) –

              The identifiers of the self-managed instances with SSM in the hybrid directory configuration.

              • (string) –

            • DnsIps (list) –

              The IP addresses of the DNS servers or domain controllers in the hybrid directory configuration.

              • (string) –

          • StartTime (datetime) –

            The date and time when the update activity was initiated.

          • LastUpdatedDateTime (datetime) –

            The date and time when the update activity status was last updated.

          • AssessmentId (string) –

            The identifier of the assessment performed to validate this update configuration.

      • HybridAdministratorAccount (list) –

        A list of update activities related to hybrid directory administrator account changes.

        • (dict) –

          Contains detailed information about a specific update activity for a hybrid directory component.

          • Status (string) –

            The current status of the update activity. Valid values include UPDATED, UPDATING, and UPDATE_FAILED.

          • StatusReason (string) –

            A human-readable description of the update status, including any error details or progress information.

          • InitiatedBy (string) –

            Specifies if the update was initiated by the customer or Amazon Web Services.

          • NewValue (dict) –

            The new configuration values being applied in this update.

            • InstanceIds (list) –

              The identifiers of the self-managed instances with SSM in the hybrid directory configuration.

              • (string) –

            • DnsIps (list) –

              The IP addresses of the DNS servers or domain controllers in the hybrid directory configuration.

              • (string) –

          • PreviousValue (dict) –

            The previous configuration values before this update was applied.

            • InstanceIds (list) –

              The identifiers of the self-managed instances with SSM in the hybrid directory configuration.

              • (string) –

            • DnsIps (list) –

              The IP addresses of the DNS servers or domain controllers in the hybrid directory configuration.

              • (string) –

          • StartTime (datetime) –

            The date and time when the update activity was initiated.

          • LastUpdatedDateTime (datetime) –

            The date and time when the update activity status was last updated.

          • AssessmentId (string) –

            The identifier of the assessment performed to validate this update configuration.

    • NextToken (string) –

      If not null, more results are available. Pass this value for the NextToken parameter in a subsequent request to retrieve the next set of items.

Exceptions