describe-hybrid-ad-update¶
Description¶
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
Synopsis¶
describe-hybrid-ad-update
--directory-id <value>
[--update-type <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--directory-id (string)
The identifier of the hybrid directory for which to retrieve update information.
--update-type (string)
The type of update activities to retrieve. Valid values include
SelfManagedInstancesandHybridAdministratorAccount.Possible values:
SelfManagedInstancesHybridAdministratorAccount
--next-token (string)
The pagination token from a previous request to DescribeHybridADUpdate . Pass null if this is the first request.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
UpdateActivities -> (structure)
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.
(structure)
Contains detailed information about a specific update activity for a hybrid directory component.
Status -> (string)
The current status of the update activity. Valid values includeUPDATED,UPDATING, andUPDATE_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 -> (structure)
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 -> (structure)
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 -> (timestamp)
The date and time when the update activity was initiated.LastUpdatedDateTime -> (timestamp)
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.
(structure)
Contains detailed information about a specific update activity for a hybrid directory component.
Status -> (string)
The current status of the update activity. Valid values includeUPDATED,UPDATING, andUPDATE_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 -> (structure)
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 -> (structure)
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 -> (timestamp)
The date and time when the update activity was initiated.LastUpdatedDateTime -> (timestamp)
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 theNextTokenparameter in a subsequent request to retrieve the next set of items.