Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Simple Systems Manager (SSM)

Client for invoking operations on Amazon Simple Systems Manager (SSM). Each operation on Amazon Simple Systems Manager (SSM) is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_ssm::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_ssm::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AddTagsToResource operation has a Client::add_tags_to_resource, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.add_tags_to_resource()
    .resource_type("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

Constructs a fluent builder for the AddTagsToResource operation.

• The fluent builder is configurable:
  • resource_type(ResourceTypeForTagging) / set_resource_type(Option<ResourceTypeForTagging>):
    required: true
    

    Specifies the type of resource you are tagging.

    The ManagedInstance type for this API operation is for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The resource ID you want to tag.

    Use the ID of the resource. Here are some examples:

    MaintenanceWindow: mw-012345abcde

    PatchBaseline: pb-012345abcde

    Automation: example-c160-4567-8519-012345abcde

    OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.

    For the Document and Parameter values, use the name of the resource. If you’re tagging a shared document, you must use the full ARN of the document.

    ManagedInstance: mi-012345abcde

    The ManagedInstance type for this API operation is only for on-premises managed nodes. You must specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    One or more tags. The value parameter is required.

    Don’t enter personally identifiable information in this field.

    
    
• On success, responds with AddTagsToResourceOutput
• On failure, responds with SdkError<AddTagsToResourceError>

impl Client

pub fn associate_ops_item_related_item( &self, ) -> AssociateOpsItemRelatedItemFluentBuilder

Constructs a fluent builder for the AssociateOpsItemRelatedItem operation.

• The fluent builder is configurable:
  • ops_item_id(impl Into<String>) / set_ops_item_id(Option<String>):
    required: true
    

    The ID of the OpsItem to which you want to associate a resource as a related item.

    
    
  • association_type(impl Into<String>) / set_association_type(Option<String>):
    required: true
    

    The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types.

    
    
  • resource_type(impl Into<String>) / set_resource_type(Option<String>):
    required: true
    

    The type of resource that you want to associate with an OpsItem. OpsCenter supports the following types:

    AWS::SSMIncidents::IncidentRecord: an Incident Manager incident.

    AWS::SSM::Document: a Systems Manager (SSM) document.

    
    
  • resource_uri(impl Into<String>) / set_resource_uri(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.

    
    
• On success, responds with AssociateOpsItemRelatedItemOutput with field(s):
  • association_id(Option<String>):

    The association ID.

• On failure, responds with SdkError<AssociateOpsItemRelatedItemError>

impl Client

pub fn cancel_command(&self) -> CancelCommandFluentBuilder

Constructs a fluent builder for the CancelCommand operation.

• The fluent builder is configurable:
  • command_id(impl Into<String>) / set_command_id(Option<String>):
    required: true
    

    The ID of the command you want to cancel.

    
    
  • instance_ids(impl Into<String>) / set_instance_ids(Option<Vec::<String>>):
    required: false
    

    (Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested.

    
    
• On success, responds with CancelCommandOutput
• On failure, responds with SdkError<CancelCommandError>

impl Client

pub fn cancel_maintenance_window_execution( &self, ) -> CancelMaintenanceWindowExecutionFluentBuilder

Constructs a fluent builder for the CancelMaintenanceWindowExecution operation.

• The fluent builder is configurable:
  • window_execution_id(impl Into<String>) / set_window_execution_id(Option<String>):
    required: true
    

    The ID of the maintenance window execution to stop.

    
    
• On success, responds with CancelMaintenanceWindowExecutionOutput with field(s):
  • window_execution_id(Option<String>):

    The ID of the maintenance window execution that has been stopped.

• On failure, responds with SdkError<CancelMaintenanceWindowExecutionError>

impl Client

pub fn create_activation(&self) -> CreateActivationFluentBuilder

Constructs a fluent builder for the CreateActivation operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A user-defined description of the resource that you want to register with Systems Manager.

    Don’t enter personally identifiable information in this field.

    
    
  • default_instance_name(impl Into<String>) / set_default_instance_name(Option<String>):
    required: false
    

    The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.

    Don’t enter personally identifiable information in this field.

    
    
  • iam_role(impl Into<String>) / set_iam_role(Option<String>):
    required: true
    

    The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create the IAM service role required for Systems Manager in a hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

    You can’t specify an IAM service-linked role for this parameter. You must create a unique role.

    
    
  • registration_limit(i32) / set_registration_limit(Option<i32>):
    required: false
    

    Specify the maximum number of managed nodes you want to register. The default value is 1.

    
    
  • expiration_date(DateTime) / set_expiration_date(Option<DateTime>):
    required: false
    

    The date by which this activation request should expire, in timestamp format, such as “2024-07-07T00:00:00”. You can specify a date up to 30 days in advance. If you don’t provide an expiration date, the activation code expires in 24 hours.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:

    • Key=OS,Value=Windows

    • Key=Environment,Value=Production

    When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

    You can’t add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with “mi-”. For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

    
    
  • registration_metadata(RegistrationMetadataItem) / set_registration_metadata(Option<Vec::<RegistrationMetadataItem>>):
    required: false
    

    Reserved for internal use.

    
    
• On success, responds with CreateActivationOutput with field(s):
  • activation_id(Option<String>):

    The ID number generated by the system when it processed the activation. The activation ID functions like a user name.

  • activation_code(Option<String>):

    The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.

• On failure, responds with SdkError<CreateActivationError>

impl Client

pub fn create_association(&self) -> CreateAssociationFluentBuilder

Constructs a fluent builder for the CreateAssociation operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.

    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another Amazon Web Services account.

    For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:

    arn:partition:ssm:region:account-id:document/document-name

    For example:

    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

    For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The document version you want to associate with the targets. Can be a specific version or the default version.

    State Manager doesn’t support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    The managed node ID.

    InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can’t use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

    
    
  • parameters(impl Into<String>, Vec::<String>) / set_parameters(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    The parameters for the runtime configuration of the document.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: false
    

    The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *. For more information about choosing targets for an association, see Understanding targets and rate controls in State Manager associations in the Amazon Web Services Systems Manager User Guide.

    
    
  • schedule_expression(impl Into<String>) / set_schedule_expression(Option<String>):
    required: false
    

    A cron expression when the association will be applied to the targets.

    
    
  • output_location(InstanceAssociationOutputLocation) / set_output_location(Option<InstanceAssociationOutputLocation>):
    required: false
    

    An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

    
    
  • association_name(impl Into<String>) / set_association_name(Option<String>):
    required: false
    

    Specify a descriptive name for the association.

    
    
  • automation_target_parameter_name(impl Into<String>) / set_automation_target_parameter_name(Option<String>):
    required: false
    

    Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.

    
    
  • max_errors(impl Into<String>) / set_max_errors(Option<String>):
    required: false
    

    The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

    Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won’t be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    
    
  • max_concurrency(impl Into<String>) / set_max_concurrency(Option<String>):
    required: false
    

    The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

    If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

    
    
  • compliance_severity(AssociationComplianceSeverity) / set_compliance_severity(Option<AssociationComplianceSeverity>):
    required: false
    

    The severity level to assign to the association.

    
    
  • sync_compliance(AssociationSyncCompliance) / set_sync_compliance(Option<AssociationSyncCompliance>):
    required: false
    

    The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn’t run successfully, the association is NON-COMPLIANT.

    In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn’t managed by State Manager. It is managed by your direct call to the PutComplianceItems API operation.

    By default, all associations use AUTO mode.

    
    
  • apply_only_at_cron_interval(bool) / set_apply_only_at_cron_interval(Option<bool>):
    required: false
    

    By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don’t want an association to run immediately after you create it. This parameter isn’t supported for rate expressions.

    
    
  • calendar_names(impl Into<String>) / set_calendar_names(Option<Vec::<String>>):
    required: false
    

    The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

    
    
  • target_locations(TargetLocation) / set_target_locations(Option<Vec::<TargetLocation>>):
    required: false
    

    A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

    
    
  • schedule_offset(i32) / set_schedule_offset(Option<i32>):
    required: false
    

    Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

    To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it.

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: false
    

    The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

    The Duration parameter applies only when both these conditions are true:

    • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

    • The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn’t run immediately after it is created, but only according to the specified schedule.

    
    
  • target_maps(HashMap::<String, Vec::<String>>) / set_target_maps(Option<Vec::<HashMap::<String, Vec::<String>>>>):
    required: false
    

    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can’t be specified together.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

    
    
  • alarm_configuration(AlarmConfiguration) / set_alarm_configuration(Option<AlarmConfiguration>):
    required: false
    

    The details for the CloudWatch alarm you want to apply to an automation or command.

    
    
• On success, responds with CreateAssociationOutput with field(s):
  • association_description(Option<AssociationDescription>):

    Information about the association.

• On failure, responds with SdkError<CreateAssociationError>

impl Client

pub fn create_association_batch(&self) -> CreateAssociationBatchFluentBuilder

Constructs a fluent builder for the CreateAssociationBatch operation.

• The fluent builder is configurable:
  • entries(CreateAssociationBatchRequestEntry) / set_entries(Option<Vec::<CreateAssociationBatchRequestEntry>>):
    required: true
    

    One or more associations.

    
    
• On success, responds with CreateAssociationBatchOutput with field(s):
  • successful(Option<Vec::<AssociationDescription>>):

    Information about the associations that succeeded.

  • failed(Option<Vec::<FailedCreateAssociation>>):

    Information about the associations that failed.

• On failure, responds with SdkError<CreateAssociationBatchError>

impl Client

pub fn create_document(&self) -> CreateDocumentFluentBuilder

Constructs a fluent builder for the CreateDocument operation.

• The fluent builder is configurable:
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

    For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

    • Create an SSM document (console)

    • Create an SSM document (command line)

    • Create an SSM document (API)

    
    
  • requires(DocumentRequires) / set_requires(Option<Vec::<DocumentRequires>>):
    required: false
    

    A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

    
    
  • attachments(AttachmentsSource) / set_attachments(Option<Vec::<AttachmentsSource>>):
    required: false
    

    A list of key-value pairs that describe attachments to a version of a document.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the SSM document.

    You can’t use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

    • aws

    • amazon

    • amzn

    • AWSEC2

    • AWSConfigRemediation

    • AWSSupport

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can’t be changed.

    
    
  • document_type(DocumentType) / set_document_type(Option<DocumentType>):
    required: false
    

    The type of document to create.

    The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

    
    
  • document_format(DocumentFormat) / set_document_format(Option<DocumentFormat>):
    required: false
    

    Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

    
    
  • target_type(impl Into<String>) / set_target_type(Option<String>):
    required: false
    

    Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of ‘/’ the document can run on all types of resources. If you don’t specify a value, the document can’t run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs:

    • Key=OS,Value=Windows

    • Key=Environment,Value=Production

    To add tags to an existing SSM document, use the AddTagsToResource operation.

    
    
• On success, responds with CreateDocumentOutput with field(s):
  • document_description(Option<DocumentDescription>):

    Information about the SSM document.

• On failure, responds with SdkError<CreateDocumentError>

impl Client

pub fn create_maintenance_window(&self) -> CreateMaintenanceWindowFluentBuilder

Constructs a fluent builder for the CreateMaintenanceWindow operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the maintenance window.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

    
    
  • start_date(impl Into<String>) / set_start_date(Option<String>):
    required: false
    

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

    When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.

    
    
  • end_date(impl Into<String>) / set_end_date(Option<String>):
    required: false
    

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

    
    
  • schedule(impl Into<String>) / set_schedule(Option<String>):
    required: true
    

    The schedule of the maintenance window in the form of a cron or rate expression.

    
    
  • schedule_timezone(impl Into<String>) / set_schedule_timezone(Option<String>):
    required: false
    

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”. For more information, see the Time Zone Database on the IANA website.

    
    
  • schedule_offset(i32) / set_schedule_offset(Option<i32>):
    required: false
    

    The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

    For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

    cron(30 23 ? * TUE#3 *)

    If the schedule offset is 2, the maintenance window won’t run until two days later.

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: true
    

    The duration of the maintenance window in hours.

    
    
  • cutoff(i32) / set_cutoff(Option<i32>):
    required: true
    

    The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

    
    
  • allow_unassociated_targets(bool) / set_allow_unassociated_targets(Option<bool>):
    required: true
    

    Enables a maintenance window task to run on managed nodes, even if you haven’t registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.

    If you don’t enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    User-provided idempotency token.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:

    • Key=TaskType,Value=AgentUpdate

    • Key=OS,Value=Windows

    • Key=Environment,Value=Production

    To add tags to an existing maintenance window, use the AddTagsToResource operation.

    
    
• On success, responds with CreateMaintenanceWindowOutput with field(s):
  • window_id(Option<String>):

    The ID of the created maintenance window.

• On failure, responds with SdkError<CreateMaintenanceWindowError>

impl Client

pub fn create_ops_item(&self) -> CreateOpsItemFluentBuilder

Constructs a fluent builder for the CreateOpsItem operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    User-defined text that contains information about the OpsItem, in Markdown format.

    Provide enough information so that users viewing this OpsItem for the first time understand the issue.

    
    
  • ops_item_type(impl Into<String>) / set_ops_item_type(Option<String>):
    required: false
    

    The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

    • /aws/issue

      This type of OpsItem is used for default OpsItems created by OpsCenter.

    • /aws/changerequest

      This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

    • /aws/insight

      This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

    
    
  • operational_data(impl Into<String>, OpsItemDataValue) / set_operational_data(Option<HashMap::<String, OpsItemDataValue>>):
    required: false
    

    Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

    Operational data keys can’t begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

    You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn’t searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

    Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Create OpsItems manually in the Amazon Web Services Systems Manager User Guide.

    
    
  • notifications(OpsItemNotification) / set_notifications(Option<Vec::<OpsItemNotification>>):
    required: false
    

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

    The importance of this OpsItem in relation to other OpsItems in the system.

    
    
  • related_ops_items(RelatedOpsItem) / set_related_ops_items(Option<Vec::<RelatedOpsItem>>):
    required: false
    

    One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: true
    

    The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

    The source name can’t contain the following strings: aws, amazon, and amzn.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: true
    

    A short heading that describes the nature of the OpsItem and the impacted resource.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Optional metadata that you assign to a resource.

    Tags use a key-value pair. For example:

    Key=Department,Value=Finance

    To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

    
    
  • category(impl Into<String>) / set_category(Option<String>):
    required: false
    

    Specify a category to assign to an OpsItem.

    
    
  • severity(impl Into<String>) / set_severity(Option<String>):
    required: false
    

    Specify a severity to assign to an OpsItem.

    
    
  • actual_start_time(DateTime) / set_actual_start_time(Option<DateTime>):
    required: false
    

    The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

    
    
  • actual_end_time(DateTime) / set_actual_end_time(Option<DateTime>):
    required: false
    

    The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

    
    
  • planned_start_time(DateTime) / set_planned_start_time(Option<DateTime>):
    required: false
    

    The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

    
    
  • planned_end_time(DateTime) / set_planned_end_time(Option<DateTime>):
    required: false
    

    The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

    
    
• On success, responds with CreateOpsItemOutput with field(s):
  • ops_item_id(Option<String>):

    The ID of the OpsItem.

  • ops_item_arn(Option<String>):

    The OpsItem Amazon Resource Name (ARN).

• On failure, responds with SdkError<CreateOpsItemError>

impl Client

pub fn create_ops_metadata(&self) -> CreateOpsMetadataFluentBuilder

Constructs a fluent builder for the CreateOpsMetadata operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    A resource ID for a new Application Manager application.

    
    
  • metadata(impl Into<String>, MetadataValue) / set_metadata(Option<HashMap::<String, MetadataValue>>):
    required: false
    

    Metadata for a new Application Manager application.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

    • Key=Environment,Value=Production

    • Key=Region,Value=us-east-2

    
    
• On success, responds with CreateOpsMetadataOutput with field(s):
  • ops_metadata_arn(Option<String>):

    The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.

• On failure, responds with SdkError<CreateOpsMetadataError>

impl Client

pub fn create_patch_baseline(&self) -> CreatePatchBaselineFluentBuilder

Constructs a fluent builder for the CreatePatchBaseline operation.

• The fluent builder is configurable:
  • operating_system(OperatingSystem) / set_operating_system(Option<OperatingSystem>):
    required: false
    

    Defines the operating system the patch baseline applies to. The default value is WINDOWS.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the patch baseline.

    
    
  • global_filters(PatchFilterGroup) / set_global_filters(Option<PatchFilterGroup>):
    required: false
    

    A set of global filters used to include patches in the baseline.

    The GlobalFilters parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can’t be configured from the Patch Manager console, and its value isn’t displayed in the console.

    
    
  • approval_rules(PatchRuleGroup) / set_approval_rules(Option<PatchRuleGroup>):
    required: false
    

    A set of rules used to include patches in the baseline.

    
    
  • approved_patches(impl Into<String>) / set_approved_patches(Option<Vec::<String>>):
    required: false
    

    A list of explicitly approved patches for the baseline.

    For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

    
    
  • approved_patches_compliance_level(PatchComplianceLevel) / set_approved_patches_compliance_level(Option<PatchComplianceLevel>):
    required: false
    

    Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED.

    
    
  • approved_patches_enable_non_security(bool) / set_approved_patches_enable_non_security(Option<bool>):
    required: false
    

    Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

    
    
  • rejected_patches(impl Into<String>) / set_rejected_patches(Option<Vec::<String>>):
    required: false
    

    A list of explicitly rejected patches for the baseline.

    For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.

    
    
  • rejected_patches_action(PatchAction) / set_rejected_patches_action(Option<PatchAction>):
    required: false
    

    The action for Patch Manager to take on patches included in the RejectedPackages list.

    ALLOW_AS_DEPENDENCY

    Linux and macOS: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as INSTALLED_OTHER. This is the default action if no option is specified.

    Windows Server: Windows Server doesn’t support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified.

    BLOCK

    All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren’t installed by Patch Manager under any circumstances. If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it’s considered noncompliant with the patch baseline and its status is reported as INSTALLED_REJECTED.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the patch baseline.

    
    
  • sources(PatchSource) / set_sources(Option<Vec::<PatchSource>>):
    required: false
    

    Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    User-provided idempotency token.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs:

    • Key=PatchSeverity,Value=Critical

    • Key=OS,Value=Windows

    To add tags to an existing patch baseline, use the AddTagsToResource operation.

    
    
• On success, responds with CreatePatchBaselineOutput with field(s):
  • baseline_id(Option<String>):

    The ID of the created patch baseline.

• On failure, responds with SdkError<CreatePatchBaselineError>

impl Client

pub fn create_resource_data_sync(&self) -> CreateResourceDataSyncFluentBuilder

Constructs a fluent builder for the CreateResourceDataSync operation.

• The fluent builder is configurable:
  • sync_name(impl Into<String>) / set_sync_name(Option<String>):
    required: true
    

    A name for the configuration.

    
    
  • s3_destination(ResourceDataSyncS3Destination) / set_s3_destination(Option<ResourceDataSyncS3Destination>):
    required: false
    

    Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.

    
    
  • sync_type(impl Into<String>) / set_sync_type(Option<String>):
    required: false
    

    Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.

    
    
  • sync_source(ResourceDataSyncSource) / set_sync_source(Option<ResourceDataSyncSource>):
    required: false
    

    Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.

    
    
• On success, responds with CreateResourceDataSyncOutput
• On failure, responds with SdkError<CreateResourceDataSyncError>

impl Client

pub fn delete_activation(&self) -> DeleteActivationFluentBuilder

Constructs a fluent builder for the DeleteActivation operation.

• The fluent builder is configurable:
  • activation_id(impl Into<String>) / set_activation_id(Option<String>):
    required: true
    

    The ID of the activation that you want to delete.

    
    
• On success, responds with DeleteActivationOutput
• On failure, responds with SdkError<DeleteActivationError>

impl Client

pub fn delete_association(&self) -> DeleteAssociationFluentBuilder

Constructs a fluent builder for the DeleteAssociation operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the SSM document.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    The managed node ID.

    InstanceId has been deprecated. To specify a managed node ID for an association, use the Targets parameter. Requests that include the parameter InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter InstanceId, you can’t use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: false
    

    The association ID that you want to delete.

    
    
• On success, responds with DeleteAssociationOutput
• On failure, responds with SdkError<DeleteAssociationError>

impl Client

pub fn delete_document(&self) -> DeleteDocumentFluentBuilder

Constructs a fluent builder for the DeleteDocument operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the document.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The version of the document that you want to delete. If not provided, all versions of the document are deleted.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an Identity and Access Management (IAM) policy.

    
    
• On success, responds with DeleteDocumentOutput
• On failure, responds with SdkError<DeleteDocumentError>

impl Client

pub fn delete_inventory(&self) -> DeleteInventoryFluentBuilder

Constructs a fluent builder for the DeleteInventory operation.

• The fluent builder is configurable:
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: true
    

    The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

    
    
  • schema_delete_option(InventorySchemaDeleteOption) / set_schema_delete_option(Option<InventorySchemaDeleteOption>):
    required: false
    

    Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don’t choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

    DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory operation for a version greater than the disabled version.

    DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    

    Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    User-provided idempotency token.

    
    
• On success, responds with DeleteInventoryOutput with field(s):
  • deletion_id(Option<String>):

    Every DeleteInventory operation is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other operations.

  • type_name(Option<String>):

    The name of the inventory data type specified in the request.

  • deletion_summary(Option<InventoryDeletionSummary>):

    A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the Amazon Web Services Systems Manager User Guide.

• On failure, responds with SdkError<DeleteInventoryError>

impl Client

pub fn delete_maintenance_window(&self) -> DeleteMaintenanceWindowFluentBuilder

Constructs a fluent builder for the DeleteMaintenanceWindow operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window to delete.

    
    
• On success, responds with DeleteMaintenanceWindowOutput with field(s):
  • window_id(Option<String>):

    The ID of the deleted maintenance window.

• On failure, responds with SdkError<DeleteMaintenanceWindowError>

impl Client

pub fn delete_ops_item(&self) -> DeleteOpsItemFluentBuilder

Constructs a fluent builder for the DeleteOpsItem operation.

• The fluent builder is configurable:
  • ops_item_id(impl Into<String>) / set_ops_item_id(Option<String>):
    required: true
    

    The ID of the OpsItem that you want to delete.

    
    
• On success, responds with DeleteOpsItemOutput
• On failure, responds with SdkError<DeleteOpsItemError>

impl Client

pub fn delete_ops_metadata(&self) -> DeleteOpsMetadataFluentBuilder

Constructs a fluent builder for the DeleteOpsMetadata operation.

• The fluent builder is configurable:
  • ops_metadata_arn(impl Into<String>) / set_ops_metadata_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.

    
    
• On success, responds with DeleteOpsMetadataOutput
• On failure, responds with SdkError<DeleteOpsMetadataError>

impl Client

pub fn delete_parameter(&self) -> DeleteParameterFluentBuilder

Constructs a fluent builder for the DeleteParameter operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the parameter to delete.

    You can’t enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.

    
    
• On success, responds with DeleteParameterOutput
• On failure, responds with SdkError<DeleteParameterError>

impl Client

pub fn delete_parameters(&self) -> DeleteParametersFluentBuilder

Constructs a fluent builder for the DeleteParameters operation.

• The fluent builder is configurable:
  • names(impl Into<String>) / set_names(Option<Vec::<String>>):
    required: true
    

    The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

    You can’t enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.

    
    
• On success, responds with DeleteParametersOutput with field(s):
  • deleted_parameters(Option<Vec::<String>>):

    The names of the deleted parameters.

  • invalid_parameters(Option<Vec::<String>>):

    The names of parameters that weren’t deleted because the parameters aren’t valid.

• On failure, responds with SdkError<DeleteParametersError>

impl Client

pub fn delete_patch_baseline(&self) -> DeletePatchBaselineFluentBuilder

Constructs a fluent builder for the DeletePatchBaseline operation.

• The fluent builder is configurable:
  • baseline_id(impl Into<String>) / set_baseline_id(Option<String>):
    required: true
    

    The ID of the patch baseline to delete.

    
    
• On success, responds with DeletePatchBaselineOutput with field(s):
  • baseline_id(Option<String>):

    The ID of the deleted patch baseline.

• On failure, responds with SdkError<DeletePatchBaselineError>

impl Client

pub fn delete_resource_data_sync(&self) -> DeleteResourceDataSyncFluentBuilder

Constructs a fluent builder for the DeleteResourceDataSync operation.

• The fluent builder is configurable:
  • sync_name(impl Into<String>) / set_sync_name(Option<String>):
    required: true
    

    The name of the configuration to delete.

    
    
  • sync_type(impl Into<String>) / set_sync_type(Option<String>):
    required: false
    

    Specify the type of resource data sync to delete.

    
    
• On success, responds with DeleteResourceDataSyncOutput
• On failure, responds with SdkError<DeleteResourceDataSyncError>

impl Client

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the resource to which the policies are attached.

    
    
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: true
    

    The policy ID.

    
    
  • policy_hash(impl Into<String>) / set_policy_hash(Option<String>):
    required: true
    

    ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.

    
    
• On success, responds with DeleteResourcePolicyOutput
• On failure, responds with SdkError<DeleteResourcePolicyError>

impl Client

pub fn deregister_managed_instance( &self, ) -> DeregisterManagedInstanceFluentBuilder

Constructs a fluent builder for the DeregisterManagedInstance operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The ID assigned to the managed node when you registered it using the activation process.

    
    
• On success, responds with DeregisterManagedInstanceOutput
• On failure, responds with SdkError<DeregisterManagedInstanceError>

impl Client

pub fn deregister_patch_baseline_for_patch_group( &self, ) -> DeregisterPatchBaselineForPatchGroupFluentBuilder

Constructs a fluent builder for the DeregisterPatchBaselineForPatchGroup operation.

• The fluent builder is configurable:
  • baseline_id(impl Into<String>) / set_baseline_id(Option<String>):
    required: true
    

    The ID of the patch baseline to deregister the patch group from.

    
    
  • patch_group(impl Into<String>) / set_patch_group(Option<String>):
    required: true
    

    The name of the patch group that should be deregistered from the patch baseline.

    
    
• On success, responds with DeregisterPatchBaselineForPatchGroupOutput with field(s):
  • baseline_id(Option<String>):

    The ID of the patch baseline the patch group was deregistered from.

  • patch_group(Option<String>):

    The name of the patch group deregistered from the patch baseline.

• On failure, responds with SdkError<DeregisterPatchBaselineForPatchGroupError>

impl Client

pub fn deregister_target_from_maintenance_window( &self, ) -> DeregisterTargetFromMaintenanceWindowFluentBuilder

Constructs a fluent builder for the DeregisterTargetFromMaintenanceWindow operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window the target should be removed from.

    
    
  • window_target_id(impl Into<String>) / set_window_target_id(Option<String>):
    required: true
    

    The ID of the target definition to remove.

    
    
  • safe(bool) / set_safe(Option<bool>):
    required: false
    

    The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and doesn’t deregister the target from the maintenance window.

    
    
• On success, responds with DeregisterTargetFromMaintenanceWindowOutput with field(s):
  • window_id(Option<String>):

    The ID of the maintenance window the target was removed from.

  • window_target_id(Option<String>):

    The ID of the removed target definition.

• On failure, responds with SdkError<DeregisterTargetFromMaintenanceWindowError>

impl Client

pub fn deregister_task_from_maintenance_window( &self, ) -> DeregisterTaskFromMaintenanceWindowFluentBuilder

Constructs a fluent builder for the DeregisterTaskFromMaintenanceWindow operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window the task should be removed from.

    
    
  • window_task_id(impl Into<String>) / set_window_task_id(Option<String>):
    required: true
    

    The ID of the task to remove from the maintenance window.

    
    
• On success, responds with DeregisterTaskFromMaintenanceWindowOutput with field(s):
  • window_id(Option<String>):

    The ID of the maintenance window the task was removed from.

  • window_task_id(Option<String>):

    The ID of the task removed from the maintenance window.

• On failure, responds with SdkError<DeregisterTaskFromMaintenanceWindowError>

impl Client

pub fn describe_activations(&self) -> DescribeActivationsFluentBuilder

Constructs a fluent builder for the DescribeActivations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(DescribeActivationsFilter) / set_filters(Option<Vec::<DescribeActivationsFilter>>):
    required: false
    

    A filter to view information about your activations.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
• On success, responds with DescribeActivationsOutput with field(s):
  • activation_list(Option<Vec::<Activation>>):

    A list of activations for your Amazon Web Services account.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<DescribeActivationsError>

impl Client

pub fn describe_association(&self) -> DescribeAssociationFluentBuilder

Constructs a fluent builder for the DescribeAssociation operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the SSM document.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    The managed node ID.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: false
    

    The association ID for which you want information.

    
    
  • association_version(impl Into<String>) / set_association_version(Option<String>):
    required: false
    

    Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for a managed node, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

    
    
• On success, responds with DescribeAssociationOutput with field(s):
  • association_description(Option<AssociationDescription>):

    Information about the association.

• On failure, responds with SdkError<DescribeAssociationError>

impl Client

pub fn describe_association_execution_targets( &self, ) -> DescribeAssociationExecutionTargetsFluentBuilder

Constructs a fluent builder for the DescribeAssociationExecutionTargets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The association ID that includes the execution for which you want to view details.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The execution ID for which you want to view details.

    
    
  • filters(AssociationExecutionTargetsFilter) / set_filters(Option<Vec::<AssociationExecutionTargetsFilter>>):
    required: false
    

    Filters for the request. You can specify the following filters and values.

    Status (EQUAL)

    ResourceId (EQUAL)

    ResourceType (EQUAL)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
• On success, responds with DescribeAssociationExecutionTargetsOutput with field(s):
  • association_execution_targets(Option<Vec::<AssociationExecutionTarget>>):

    Information about the execution.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<DescribeAssociationExecutionTargetsError>

impl Client

pub fn describe_association_executions( &self, ) -> DescribeAssociationExecutionsFluentBuilder

Constructs a fluent builder for the DescribeAssociationExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The association ID for which you want to view execution history details.

    
    
  • filters(AssociationExecutionFilter) / set_filters(Option<Vec::<AssociationExecutionFilter>>):
    required: false
    

    Filters for the request. You can specify the following filters and values.

    ExecutionId (EQUAL)

    Status (EQUAL)

    CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
• On success, responds with DescribeAssociationExecutionsOutput with field(s):
  • association_executions(Option<Vec::<AssociationExecution>>):

    A list of the executions for the specified association ID.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<DescribeAssociationExecutionsError>

impl Client

pub fn describe_automation_executions( &self, ) -> DescribeAutomationExecutionsFluentBuilder

Constructs a fluent builder for the DescribeAutomationExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(AutomationExecutionFilter) / set_filters(Option<Vec::<AutomationExecutionFilter>>):
    required: false
    

    Filters used to limit the scope of executions that are requested.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeAutomationExecutionsOutput with field(s):
  • automation_execution_metadata_list(Option<Vec::<AutomationExecutionMetadata>>):

    The list of details about each automation execution which has occurred which matches the filter specification, if any.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeAutomationExecutionsError>

impl Client

pub fn describe_automation_step_executions( &self, ) -> DescribeAutomationStepExecutionsFluentBuilder

Constructs a fluent builder for the DescribeAutomationStepExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • automation_execution_id(impl Into<String>) / set_automation_execution_id(Option<String>):
    required: true
    

    The Automation execution ID for which you want step execution descriptions.

    
    
  • filters(StepExecutionFilter) / set_filters(Option<Vec::<StepExecutionFilter>>):
    required: false
    

    One or more filters to limit the number of step executions returned by the request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • reverse_order(bool) / set_reverse_order(Option<bool>):
    required: false
    

    Indicates whether to list step executions in reverse order by start time. The default value is ‘false’.

    
    
• On success, responds with DescribeAutomationStepExecutionsOutput with field(s):
  • step_executions(Option<Vec::<StepExecution>>):

    A list of details about the current state of all steps that make up an execution.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeAutomationStepExecutionsError>

impl Client

pub fn describe_available_patches( &self, ) -> DescribeAvailablePatchesFluentBuilder

Constructs a fluent builder for the DescribeAvailablePatches operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(PatchOrchestratorFilter) / set_filters(Option<Vec::<PatchOrchestratorFilter>>):
    required: false
    

    Each element in the array is a structure containing a key-value pair.

    Windows Server

    Supported keys for Windows Server managed node patches include the following:

    • PATCH_SET

      Sample values: OS | APPLICATION

    • PRODUCT

      Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus

    • PRODUCT_FAMILY

      Sample values: Windows | Office

    • MSRC_SEVERITY

      Sample values: ServicePacks | Important | Moderate

    • CLASSIFICATION

      Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates

    • PATCH_ID

      Sample values: KB123456 | KB4516046

    Linux

    When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the Command Line Interface (CLI), the following command fails:

    aws ssm describe-available-patches –filters Key=CVE_ID,Values=CVE-2018-3615

    However, the following command succeeds:

    aws ssm describe-available-patches –filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615

    Supported keys for Linux managed node patches include the following:

    • PRODUCT

      Sample values: AmazonLinux2018.03 | AmazonLinux2.0

    • NAME

      Sample values: kernel-headers | samba-python | php

    • SEVERITY

      Sample values: Critical | Important | Medium | Low

    • EPOCH

      Sample values: 0 | 1

    • VERSION

      Sample values: 78.6.1 | 4.10.16

    • RELEASE

      Sample values: 9.56.amzn1 | 1.amzn2

    • ARCH

      Sample values: i686 | x86_64

    • REPOSITORY

      Sample values: Core | Updates

    • ADVISORY_ID

      Sample values: ALAS-2018-1058 | ALAS2-2021-1594

    • CVE_ID

      Sample values: CVE-2018-3615 | CVE-2020-1472

    • BUGZILLA_ID

      Sample values: 1463241

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of patches to return (per page).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeAvailablePatchesOutput with field(s):
  • patches(Option<Vec::<Patch>>):

    An array of patches. Each entry in the array is a patch structure.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeAvailablePatchesError>

impl Client

pub fn describe_document(&self) -> DescribeDocumentFluentBuilder

Constructs a fluent builder for the DescribeDocument operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the SSM document.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The document version for which you want information. Can be a specific version or the default version.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can’t be changed.

    
    
• On success, responds with DescribeDocumentOutput with field(s):
  • document(Option<DocumentDescription>):

    Information about the SSM document.

• On failure, responds with SdkError<DescribeDocumentError>

impl Client

pub fn describe_document_permission( &self, ) -> DescribeDocumentPermissionFluentBuilder

Constructs a fluent builder for the DescribeDocumentPermission operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the document for which you are the owner.

    
    
  • permission_type(DocumentPermissionType) / set_permission_type(Option<DocumentPermissionType>):
    required: true
    

    The permission type for the document. The permission type can be Share.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeDocumentPermissionOutput with field(s):
  • account_ids(Option<Vec::<String>>):

    The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or All.

  • account_sharing_info_list(Option<Vec::<AccountSharingInfo>>):

    A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<DescribeDocumentPermissionError>

impl Client

pub fn describe_effective_instance_associations( &self, ) -> DescribeEffectiveInstanceAssociationsFluentBuilder

Constructs a fluent builder for the DescribeEffectiveInstanceAssociations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The managed node ID for which you want to view all associations.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeEffectiveInstanceAssociationsOutput with field(s):
  • associations(Option<Vec::<InstanceAssociation>>):

    The associations for the requested managed node.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeEffectiveInstanceAssociationsError>

impl Client

pub fn describe_effective_patches_for_patch_baseline( &self, ) -> DescribeEffectivePatchesForPatchBaselineFluentBuilder

Constructs a fluent builder for the DescribeEffectivePatchesForPatchBaseline operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • baseline_id(impl Into<String>) / set_baseline_id(Option<String>):
    required: true
    

    The ID of the patch baseline to retrieve the effective patches for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of patches to return (per page).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeEffectivePatchesForPatchBaselineOutput with field(s):
  • effective_patches(Option<Vec::<EffectivePatch>>):

    An array of patches and patch status.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeEffectivePatchesForPatchBaselineError>

impl Client

pub fn describe_instance_associations_status( &self, ) -> DescribeInstanceAssociationsStatusFluentBuilder

Constructs a fluent builder for the DescribeInstanceAssociationsStatus operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The managed node IDs for which you want association status information.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeInstanceAssociationsStatusOutput with field(s):
  • instance_association_status_infos(Option<Vec::<InstanceAssociationStatusInfo>>):

    Status information about the association.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeInstanceAssociationsStatusError>

impl Client

pub fn describe_instance_information( &self, ) -> DescribeInstanceInformationFluentBuilder

Constructs a fluent builder for the DescribeInstanceInformation operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_information_filter_list(InstanceInformationFilter) / set_instance_information_filter_list(Option<Vec::<InstanceInformationFilter>>):
    required: false
    

    This is a legacy method. We recommend that you don’t use this method. Instead, use the Filters data type. Filters enables you to return node information by filtering based on tags applied to managed nodes.

    Attempting to use InstanceInformationFilterList and Filters leads to an exception error.

    
    
  • filters(InstanceInformationStringFilter) / set_filters(Option<Vec::<InstanceInformationStringFilter>>):
    required: false
    

    One or more filters. Use a filter to return a more specific list of managed nodes. You can filter based on tags applied to your managed nodes. Tag filters can’t be combined with other filter types. Use this Filters data type instead of InstanceInformationFilterList, which is deprecated.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. The default value is 10 items.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeInstanceInformationOutput with field(s):
  • instance_information_list(Option<Vec::<InstanceInformation>>):

    The managed node information list.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeInstanceInformationError>

impl Client

pub fn describe_instance_patch_states( &self, ) -> DescribeInstancePatchStatesFluentBuilder

Constructs a fluent builder for the DescribeInstancePatchStates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_ids(impl Into<String>) / set_instance_ids(Option<Vec::<String>>):
    required: true
    

    The ID of the managed node for which patch state information should be retrieved.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of managed nodes to return (per page).

    
    
• On success, responds with DescribeInstancePatchStatesOutput with field(s):
  • instance_patch_states(Option<Vec::<InstancePatchState>>):

    The high-level patch state for the requested managed nodes.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeInstancePatchStatesError>

impl Client

pub fn describe_instance_patch_states_for_patch_group( &self, ) -> DescribeInstancePatchStatesForPatchGroupFluentBuilder

Constructs a fluent builder for the DescribeInstancePatchStatesForPatchGroup operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • patch_group(impl Into<String>) / set_patch_group(Option<String>):
    required: true
    

    The name of the patch group for which the patch state information should be retrieved.

    
    
  • filters(InstancePatchStateFilter) / set_filters(Option<Vec::<InstancePatchStateFilter>>):
    required: false
    

    Each entry in the array is a structure containing:

    • Key (string between 1 and 200 characters)

    • Values (array containing a single string)

    • Type (string “Equal”, “NotEqual”, “LessThan”, “GreaterThan”)

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of patches to return (per page).

    
    
• On success, responds with DescribeInstancePatchStatesForPatchGroupOutput with field(s):
  • instance_patch_states(Option<Vec::<InstancePatchState>>):

    The high-level patch state for the requested managed nodes.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeInstancePatchStatesForPatchGroupError>

impl Client

pub fn describe_instance_patches(&self) -> DescribeInstancePatchesFluentBuilder

Constructs a fluent builder for the DescribeInstancePatches operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The ID of the managed node whose patch state information should be retrieved.

    
    
  • filters(PatchOrchestratorFilter) / set_filters(Option<Vec::<PatchOrchestratorFilter>>):
    required: false
    

    Each element in the array is a structure containing a key-value pair.

    Supported keys for DescribeInstancePatchesinclude the following:

    • Classification

      Sample values: Security | SecurityUpdates

    • KBId

      Sample values: KB4480056 | java-1.7.0-openjdk.x86_64

    • Severity

      Sample values: Important | Medium | Low

    • State

      Sample values: Installed | InstalledOther | InstalledPendingReboot

      For lists of all State values, see Patch compliance state values in the Amazon Web Services Systems Manager User Guide.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of patches to return (per page).

    
    
• On success, responds with DescribeInstancePatchesOutput with field(s):
  • patches(Option<Vec::<PatchComplianceData>>):

    Each entry in the array is a structure containing:

    • Title (string)

    • KBId (string)

    • Classification (string)

    • Severity (string)

    • State (string, such as “INSTALLED” or “FAILED”)

    • InstalledTime (DateTime)

    • InstalledBy (string)

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeInstancePatchesError>

impl Client

pub fn describe_instance_properties( &self, ) -> DescribeInstancePropertiesFluentBuilder

Constructs a fluent builder for the DescribeInstanceProperties operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_property_filter_list(InstancePropertyFilter) / set_instance_property_filter_list(Option<Vec::<InstancePropertyFilter>>):
    required: false
    

    An array of instance property filters.

    
    
  • filters_with_operator(InstancePropertyStringFilter) / set_filters_with_operator(Option<Vec::<InstancePropertyStringFilter>>):
    required: false
    

    The request filters to use with the operator.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for the call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token provided by a previous request to use to return the next set of properties.

    
    
• On success, responds with DescribeInstancePropertiesOutput with field(s):
  • instance_properties(Option<Vec::<InstanceProperty>>):

    Properties for the managed instances.

  • next_token(Option<String>):

    The token for the next set of properties to return. Use this token to get the next set of results.

• On failure, responds with SdkError<DescribeInstancePropertiesError>

impl Client

pub fn describe_inventory_deletions( &self, ) -> DescribeInventoryDeletionsFluentBuilder

Constructs a fluent builder for the DescribeInventoryDeletions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • deletion_id(impl Into<String>) / set_deletion_id(Option<String>):
    required: false
    

    Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with DescribeInventoryDeletionsOutput with field(s):
  • inventory_deletions(Option<Vec::<InventoryDeletionStatusItem>>):

    A list of status items for deleted inventory.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<DescribeInventoryDeletionsError>

impl Client

pub fn describe_maintenance_window_execution_task_invocations( &self, ) -> DescribeMaintenanceWindowExecutionTaskInvocationsFluentBuilder

Constructs a fluent builder for the DescribeMaintenanceWindowExecutionTaskInvocations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • window_execution_id(impl Into<String>) / set_window_execution_id(Option<String>):
    required: true
    

    The ID of the maintenance window execution the task is part of.

    
    
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The ID of the specific task in the maintenance window task that should be retrieved.

    
    
  • filters(MaintenanceWindowFilter) / set_filters(Option<Vec::<MaintenanceWindowFilter>>):
    required: false
    

    Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeMaintenanceWindowExecutionTaskInvocationsOutput with field(s):
  • window_execution_task_invocation_identities(Option<Vec::<MaintenanceWindowExecutionTaskInvocationIdentity>>):

    Information about the task invocation results per invocation.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeMaintenanceWindowExecutionTaskInvocationsError>

impl Client

pub fn describe_maintenance_window_execution_tasks( &self, ) -> DescribeMaintenanceWindowExecutionTasksFluentBuilder

Constructs a fluent builder for the DescribeMaintenanceWindowExecutionTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • window_execution_id(impl Into<String>) / set_window_execution_id(Option<String>):
    required: true
    

    The ID of the maintenance window execution whose task executions should be retrieved.

    
    
  • filters(MaintenanceWindowFilter) / set_filters(Option<Vec::<MaintenanceWindowFilter>>):
    required: false
    

    Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeMaintenanceWindowExecutionTasksOutput with field(s):
  • window_execution_task_identities(Option<Vec::<MaintenanceWindowExecutionTaskIdentity>>):

    Information about the task executions.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeMaintenanceWindowExecutionTasksError>

impl Client

pub fn describe_maintenance_window_executions( &self, ) -> DescribeMaintenanceWindowExecutionsFluentBuilder

Constructs a fluent builder for the DescribeMaintenanceWindowExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window whose executions should be retrieved.

    
    
  • filters(MaintenanceWindowFilter) / set_filters(Option<Vec::<MaintenanceWindowFilter>>):
    required: false
    

    Each entry in the array is a structure containing:

    • Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter.

    • Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2024-11-04T05:00:00Z.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeMaintenanceWindowExecutionsOutput with field(s):
  • window_executions(Option<Vec::<MaintenanceWindowExecution>>):

    Information about the maintenance window executions.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeMaintenanceWindowExecutionsError>

impl Client

pub fn describe_maintenance_window_schedule( &self, ) -> DescribeMaintenanceWindowScheduleFluentBuilder

Constructs a fluent builder for the DescribeMaintenanceWindowSchedule operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: false
    

    The ID of the maintenance window to retrieve information about.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: false
    

    The managed node ID or key-value pair to retrieve information about.

    
    
  • resource_type(MaintenanceWindowResourceType) / set_resource_type(Option<MaintenanceWindowResourceType>):
    required: false
    

    The type of resource you want to retrieve information about. For example, INSTANCE.

    
    
  • filters(PatchOrchestratorFilter) / set_filters(Option<Vec::<PatchOrchestratorFilter>>):
    required: false
    

    Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeMaintenanceWindowScheduleOutput with field(s):
  • scheduled_window_executions(Option<Vec::<ScheduledWindowExecution>>):

    Information about maintenance window executions scheduled for the specified time range.

  • next_token(Option<String>):

    The token for the next set of items to return. (You use this token in the next call.)

• On failure, responds with SdkError<DescribeMaintenanceWindowScheduleError>

impl Client

pub fn describe_maintenance_window_targets( &self, ) -> DescribeMaintenanceWindowTargetsFluentBuilder

Constructs a fluent builder for the DescribeMaintenanceWindowTargets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window whose targets should be retrieved.

    
    
  • filters(MaintenanceWindowFilter) / set_filters(Option<Vec::<MaintenanceWindowFilter>>):
    required: false
    

    Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId, and OwnerInformation.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeMaintenanceWindowTargetsOutput with field(s):
  • targets(Option<Vec::<MaintenanceWindowTarget>>):

    Information about the targets in the maintenance window.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeMaintenanceWindowTargetsError>

impl Client

pub fn describe_maintenance_window_tasks( &self, ) -> DescribeMaintenanceWindowTasksFluentBuilder

Constructs a fluent builder for the DescribeMaintenanceWindowTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window whose tasks should be retrieved.

    
    
  • filters(MaintenanceWindowFilter) / set_filters(Option<Vec::<MaintenanceWindowFilter>>):
    required: false
    

    Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeMaintenanceWindowTasksOutput with field(s):
  • tasks(Option<Vec::<MaintenanceWindowTask>>):

    Information about the tasks in the maintenance window.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeMaintenanceWindowTasksError>

impl Client

pub fn describe_maintenance_windows( &self, ) -> DescribeMaintenanceWindowsFluentBuilder

Constructs a fluent builder for the DescribeMaintenanceWindows operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(MaintenanceWindowFilter) / set_filters(Option<Vec::<MaintenanceWindowFilter>>):
    required: false
    

    Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled. For example, Name=MyMaintenanceWindow and Enabled=True.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeMaintenanceWindowsOutput with field(s):
  • window_identities(Option<Vec::<MaintenanceWindowIdentity>>):

    Information about the maintenance windows.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribeMaintenanceWindowsError>

impl Client

pub fn describe_maintenance_windows_for_target( &self, ) -> DescribeMaintenanceWindowsForTargetFluentBuilder

Constructs a fluent builder for the DescribeMaintenanceWindowsForTarget operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: true
    

    The managed node ID or key-value pair to retrieve information about.

    
    
  • resource_type(MaintenanceWindowResourceType) / set_resource_type(Option<MaintenanceWindowResourceType>):
    required: true
    

    The type of resource you want to retrieve information about. For example, INSTANCE.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribeMaintenanceWindowsForTargetOutput with field(s):
  • window_identities(Option<Vec::<MaintenanceWindowIdentityForTarget>>):

    Information about the maintenance window targets and tasks a managed node is associated with.

  • next_token(Option<String>):

    The token for the next set of items to return. (You use this token in the next call.)

• On failure, responds with SdkError<DescribeMaintenanceWindowsForTargetError>

impl Client

pub fn describe_ops_items(&self) -> DescribeOpsItemsFluentBuilder

Constructs a fluent builder for the DescribeOpsItems operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • ops_item_filters(OpsItemFilter) / set_ops_item_filters(Option<Vec::<OpsItemFilter>>):
    required: false
    

    One or more filters to limit the response.

    • Key: CreatedTime

      Operations: GreaterThan, LessThan

    • Key: LastModifiedBy

      Operations: Contains, Equals

    • Key: LastModifiedTime

      Operations: GreaterThan, LessThan

    • Key: Priority

      Operations: Equals

    • Key: Source

      Operations: Contains, Equals

    • Key: Status

      Operations: Equals

    • Key: Title*

      Operations: Equals,Contains

    • Key: OperationalData**

      Operations: Equals

    • Key: OperationalDataKey

      Operations: Equals

    • Key: OperationalDataValue

      Operations: Equals, Contains

    • Key: OpsItemId

      Operations: Equals

    • Key: ResourceId

      Operations: Contains

    • Key: AutomationId

      Operations: Equals

    • Key: AccountId

      Operations: Equals

    *The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

    **If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {“key”:“key_name”,“value”:“a_value”}

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
• On success, responds with DescribeOpsItemsOutput with field(s):
  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

  • ops_item_summaries(Option<Vec::<OpsItemSummary>>):

    A list of OpsItems.

• On failure, responds with SdkError<DescribeOpsItemsError>

impl Client

pub fn describe_parameters(&self) -> DescribeParametersFluentBuilder

Constructs a fluent builder for the DescribeParameters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(ParametersFilter) / set_filters(Option<Vec::<ParametersFilter>>):
    required: false
    

    This data type is deprecated. Instead, use ParameterFilters.

    
    
  • parameter_filters(ParameterStringFilter) / set_parameter_filters(Option<Vec::<ParameterStringFilter>>):
    required: false
    

    Filters to limit the request results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • shared(bool) / set_shared(Option<bool>):
    required: false
    

    Lists parameters that are shared with you.

    By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.

    For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

    
    
• On success, responds with DescribeParametersOutput with field(s):
  • parameters(Option<Vec::<ParameterMetadata>>):

    Parameters returned by the request.

  • next_token(Option<String>):

    The token to use when requesting the next set of items.

• On failure, responds with SdkError<DescribeParametersError>

impl Client

pub fn describe_patch_baselines(&self) -> DescribePatchBaselinesFluentBuilder

Constructs a fluent builder for the DescribePatchBaselines operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(PatchOrchestratorFilter) / set_filters(Option<Vec::<PatchOrchestratorFilter>>):
    required: false
    

    Each element in the array is a structure containing a key-value pair.

    Supported keys for DescribePatchBaselines include the following:

    • NAME_PREFIX

      Sample values: AWS- | My-

    • OWNER

      Sample values: AWS | Self

    • OPERATING_SYSTEM

      Sample values: AMAZON_LINUX | SUSE | WINDOWS

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of patch baselines to return (per page).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribePatchBaselinesOutput with field(s):
  • baseline_identities(Option<Vec::<PatchBaselineIdentity>>):

    An array of PatchBaselineIdentity elements.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribePatchBaselinesError>

impl Client

pub fn describe_patch_group_state(&self) -> DescribePatchGroupStateFluentBuilder

Constructs a fluent builder for the DescribePatchGroupState operation.

• The fluent builder is configurable:
  • patch_group(impl Into<String>) / set_patch_group(Option<String>):
    required: true
    

    The name of the patch group whose patch snapshot should be retrieved.

    
    
• On success, responds with DescribePatchGroupStateOutput with field(s):
  • instances(i32):

    The number of managed nodes in the patch group.

  • instances_with_installed_patches(i32):

    The number of managed nodes with installed patches.

  • instances_with_installed_other_patches(i32):

    The number of managed nodes with patches installed that aren’t defined in the patch baseline.

  • instances_with_installed_pending_reboot_patches(Option<i32>):

    The number of managed nodes with patches installed by Patch Manager that haven’t been rebooted after the patch installation. The status of these managed nodes is NON_COMPLIANT.

  • instances_with_installed_rejected_patches(Option<i32>):

    The number of managed nodes with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.

    If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).

  • instances_with_missing_patches(i32):

    The number of managed nodes with missing patches from the patch baseline.

  • instances_with_failed_patches(i32):

    The number of managed nodes with patches from the patch baseline that failed to install.

  • instances_with_not_applicable_patches(i32):

    The number of managed nodes with patches that aren’t applicable.

  • instances_with_unreported_not_applicable_patches(Option<i32>):

    The number of managed nodes with NotApplicable patches beyond the supported limit, which aren’t reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.

  • instances_with_critical_non_compliant_patches(Option<i32>):

    The number of managed nodes where patches that are specified as Critical for compliance reporting in the patch baseline aren’t installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

  • instances_with_security_non_compliant_patches(Option<i32>):

    The number of managed nodes where patches that are specified as Security in a patch advisory aren’t installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

  • instances_with_other_non_compliant_patches(Option<i32>):

    The number of managed nodes with patches installed that are specified as other than Critical or Security but aren’t compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT.

• On failure, responds with SdkError<DescribePatchGroupStateError>

impl Client

pub fn describe_patch_groups(&self) -> DescribePatchGroupsFluentBuilder

Constructs a fluent builder for the DescribePatchGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of patch groups to return (per page).

    
    
  • filters(PatchOrchestratorFilter) / set_filters(Option<Vec::<PatchOrchestratorFilter>>):
    required: false
    

    Each element in the array is a structure containing a key-value pair.

    Supported keys for DescribePatchGroups include the following:

    • NAME_PREFIX

      Sample values: AWS- | My-.

    • OPERATING_SYSTEM

      Sample values: AMAZON_LINUX | SUSE | WINDOWS

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribePatchGroupsOutput with field(s):
  • mappings(Option<Vec::<PatchGroupPatchBaselineMapping>>):

    Each entry in the array contains:

    • PatchGroup: string (between 1 and 256 characters. Regex: ^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$)

    • PatchBaselineIdentity: A PatchBaselineIdentity element.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<DescribePatchGroupsError>

impl Client

pub fn describe_patch_properties(&self) -> DescribePatchPropertiesFluentBuilder

Constructs a fluent builder for the DescribePatchProperties operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • operating_system(OperatingSystem) / set_operating_system(Option<OperatingSystem>):
    required: true
    

    The operating system type for which to list patches.

    
    
  • property(PatchProperty) / set_property(Option<PatchProperty>):
    required: true
    

    The patch property for which you want to view patch details.

    
    
  • patch_set(PatchSet) / set_patch_set(Option<PatchSet>):
    required: false
    

    Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with DescribePatchPropertiesOutput with field(s):
  • properties(Option<Vec::<HashMap::<String, String>>>):

    A list of the properties for patches matching the filter request parameters.

  • next_token(Option<String>):

    The token for the next set of items to return. (You use this token in the next call.)

• On failure, responds with SdkError<DescribePatchPropertiesError>

impl Client

pub fn describe_sessions(&self) -> DescribeSessionsFluentBuilder

Constructs a fluent builder for the DescribeSessions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • state(SessionState) / set_state(Option<SessionState>):
    required: true
    

    The session status to retrieve a list of sessions for. For example, “Active”.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • filters(SessionFilter) / set_filters(Option<Vec::<SessionFilter>>):
    required: false
    

    One or more filters to limit the type of sessions returned by the request.

    
    
• On success, responds with DescribeSessionsOutput with field(s):
  • sessions(Option<Vec::<Session>>):

    A list of sessions meeting the request parameters.

  • next_token(Option<String>):

    The token for the next set of items to return. (You received this token from a previous call.)

• On failure, responds with SdkError<DescribeSessionsError>

impl Client

pub fn disassociate_ops_item_related_item( &self, ) -> DisassociateOpsItemRelatedItemFluentBuilder

Constructs a fluent builder for the DisassociateOpsItemRelatedItem operation.

• The fluent builder is configurable:
  • ops_item_id(impl Into<String>) / set_ops_item_id(Option<String>):
    required: true
    

    The ID of the OpsItem for which you want to delete an association between the OpsItem and a related item.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID of the association for which you want to delete an association between the OpsItem and a related item.

    
    
• On success, responds with DisassociateOpsItemRelatedItemOutput
• On failure, responds with SdkError<DisassociateOpsItemRelatedItemError>

impl Client

pub fn get_automation_execution(&self) -> GetAutomationExecutionFluentBuilder

Constructs a fluent builder for the GetAutomationExecution operation.

• The fluent builder is configurable:
  • automation_execution_id(impl Into<String>) / set_automation_execution_id(Option<String>):
    required: true
    

    The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation runbook is initiated.

    
    
• On success, responds with GetAutomationExecutionOutput with field(s):
  • automation_execution(Option<AutomationExecution>):

    Detailed information about the current state of an automation execution.

• On failure, responds with SdkError<GetAutomationExecutionError>

impl Client

pub fn get_calendar_state(&self) -> GetCalendarStateFluentBuilder

Constructs a fluent builder for the GetCalendarState operation.

• The fluent builder is configurable:
  • calendar_names(impl Into<String>) / set_calendar_names(Option<Vec::<String>>):
    required: true
    

    The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.

    
    
  • at_time(impl Into<String>) / set_at_time(Option<String>):
    required: false
    

    (Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you don’t specify a value or AtTime, the current time is used.

    
    
• On success, responds with GetCalendarStateOutput with field(s):
  • state(Option<CalendarState>):

    The state of the calendar. An OPEN calendar indicates that actions are allowed to proceed, and a CLOSED calendar indicates that actions aren’t allowed to proceed.

  • at_time(Option<String>):

    The time, as an ISO 8601 string, that you specified in your command. If you don’t specify a time, GetCalendarState uses the current time.

  • next_transition_time(Option<String>):

    The time, as an ISO 8601 string, that the calendar state will change. If the current calendar state is OPEN, NextTransitionTime indicates when the calendar state changes to CLOSED, and vice-versa.

• On failure, responds with SdkError<GetCalendarStateError>

impl Client

pub fn get_command_invocation(&self) -> GetCommandInvocationFluentBuilder

Constructs a fluent builder for the GetCommandInvocation operation.

• The fluent builder is configurable:
  • command_id(impl Into<String>) / set_command_id(Option<String>):
    required: true
    

    (Required) The parent command ID of the invocation plugin.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    (Required) The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

    
    
  • plugin_name(impl Into<String>) / set_plugin_name(Option<String>):
    required: false
    

    The name of the step for which you want detailed results. If the document contains only one step, you can omit the name and details for that step. If the document contains more than one step, you must specify the name of the step for which you want to view details. Be sure to specify the name of the step, not the name of a plugin like aws:RunShellScript.

    To find the PluginName, check the document content and find the name of the step you want details for. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

    
    
• On success, responds with GetCommandInvocationOutput with field(s):
  • command_id(Option<String>):

    The parent command ID of the invocation plugin.

  • instance_id(Option<String>):

    The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

  • comment(Option<String>):

    The comment text for the command.

  • document_name(Option<String>):

    The name of the document that was run. For example, AWS-RunShellScript.

  • document_version(Option<String>):

    The Systems Manager document (SSM document) version used in the request.

  • plugin_name(Option<String>):

    The name of the plugin, or step name, for which details are reported. For example, aws:RunShellScript is a plugin.

  • response_code(i32):

    The error level response code for the plugin script. If the response code is -1, then the command hasn’t started running on the managed node, or it wasn’t received by the node.

  • execution_start_date_time(Option<String>):

    The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedBefore filter.

    aws ssm list-commands –filters key=InvokedBefore,value=2017-06-07T00:00:00Z

    If the plugin hasn’t started to run, the string is empty.

  • execution_elapsed_time(Option<String>):

    Duration since ExecutionStartDateTime.

  • execution_end_date_time(Option<String>):

    The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedAfter filter.

    aws ssm list-commands –filters key=InvokedAfter,value=2017-06-07T00:00:00Z

    If the plugin hasn’t started to run, the string is empty.

  • status(Option<CommandInvocationStatus>):

    The status of this invocation plugin. This status can be different than StatusDetails.

  • status_details(Option<String>):

    A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

    • Pending: The command hasn’t been sent to the managed node.

    • In Progress: The command has been sent to the managed node but hasn’t reached a terminal state.

    • Delayed: The system attempted to send the command to the target, but the target wasn’t available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.

    • Success: The command or plugin ran successfully. This is a terminal state.

    • Delivery Timed Out: The command wasn’t delivered to the managed node before the delivery timeout expired. Delivery timeouts don’t count against the parent command’s MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

    • Execution Timed Out: The command started to run on the managed node, but the execution wasn’t complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

    • Failed: The command wasn’t run successfully on the managed node. For a plugin, this indicates that the result code wasn’t zero. For a command invocation, this indicates that the result code for one or more plugins wasn’t zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

    • Cancelled: The command was terminated before it was completed. This is a terminal state.

    • Undeliverable: The command can’t be delivered to the managed node. The node might not exist or might not be responding. Undeliverable invocations don’t count against the parent command’s MaxErrors limit and don’t contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

    • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

  • standard_output_content(Option<String>):

    The first 24,000 characters written by the plugin to stdout. If the command hasn’t finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.

  • standard_output_url(Option<String>):

    The URL for the complete text written by the plugin to stdout in Amazon Simple Storage Service (Amazon S3). If an S3 bucket wasn’t specified, then this string is empty.

  • standard_error_content(Option<String>):

    The first 8,000 characters written by the plugin to stderr. If the command hasn’t finished running, then this string is empty.

  • standard_error_url(Option<String>):

    The URL for the complete text written by the plugin to stderr. If the command hasn’t finished running, then this string is empty.

  • cloud_watch_output_config(Option<CloudWatchOutputConfig>):

    Amazon CloudWatch Logs information where Systems Manager sent the command output.

• On failure, responds with SdkError<GetCommandInvocationError>

impl Client

pub fn get_connection_status(&self) -> GetConnectionStatusFluentBuilder

Constructs a fluent builder for the GetConnectionStatus operation.

• The fluent builder is configurable:
  • target(impl Into<String>) / set_target(Option<String>):
    required: true
    

    The managed node ID.

    
    
• On success, responds with GetConnectionStatusOutput with field(s):
  • target(Option<String>):

    The ID of the managed node to check connection status.

  • status(Option<ConnectionStatus>):

    The status of the connection to the managed node.

• On failure, responds with SdkError<GetConnectionStatusError>

impl Client

pub fn get_default_patch_baseline(&self) -> GetDefaultPatchBaselineFluentBuilder

Constructs a fluent builder for the GetDefaultPatchBaseline operation.

• The fluent builder is configurable:
  • operating_system(OperatingSystem) / set_operating_system(Option<OperatingSystem>):
    required: false
    

    Returns the default patch baseline for the specified operating system.

    
    
• On success, responds with GetDefaultPatchBaselineOutput with field(s):
  • baseline_id(Option<String>):

    The ID of the default patch baseline.

  • operating_system(Option<OperatingSystem>):

    The operating system for the returned patch baseline.

• On failure, responds with SdkError<GetDefaultPatchBaselineError>

impl Client

pub fn get_deployable_patch_snapshot_for_instance( &self, ) -> GetDeployablePatchSnapshotForInstanceFluentBuilder

Constructs a fluent builder for the GetDeployablePatchSnapshotForInstance operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The ID of the managed node for which the appropriate patch snapshot should be retrieved.

    
    
  • snapshot_id(impl Into<String>) / set_snapshot_id(Option<String>):
    required: true
    

    The snapshot ID provided by the user when running AWS-RunPatchBaseline.

    
    
  • baseline_override(BaselineOverride) / set_baseline_override(Option<BaselineOverride>):
    required: false
    

    Defines the basic information about a patch baseline override.

    
    
• On success, responds with GetDeployablePatchSnapshotForInstanceOutput with field(s):
  • instance_id(Option<String>):

    The managed node ID.

  • snapshot_id(Option<String>):

    The user-defined snapshot ID.

  • snapshot_download_url(Option<String>):

    A pre-signed Amazon Simple Storage Service (Amazon S3) URL that can be used to download the patch snapshot.

  • product(Option<String>):

    Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the managed node for the specified patch snapshot.

• On failure, responds with SdkError<GetDeployablePatchSnapshotForInstanceError>

impl Client

pub fn get_document(&self) -> GetDocumentFluentBuilder

Constructs a fluent builder for the GetDocument operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the SSM document.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document and can’t be changed.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The document version for which you want information.

    
    
  • document_format(DocumentFormat) / set_document_format(Option<DocumentFormat>):
    required: false
    

    Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

    
    
• On success, responds with GetDocumentOutput with field(s):
  • name(Option<String>):

    The name of the SSM document.

  • created_date(Option<DateTime>):

    The date the SSM document was created.

  • display_name(Option<String>):

    The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

  • version_name(Option<String>):

    The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can’t be changed.

  • document_version(Option<String>):

    The document version.

  • status(Option<DocumentStatus>):

    The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

  • status_information(Option<String>):

    A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, “The specified S3 bucket doesn’t exist. Verify that the URL of the S3 bucket is correct.”

  • content(Option<String>):

    The contents of the SSM document.

  • document_type(Option<DocumentType>):

    The document type.

  • document_format(Option<DocumentFormat>):

    The document format, either JSON or YAML.

  • requires(Option<Vec::<DocumentRequires>>):

    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

  • attachments_content(Option<Vec::<AttachmentContent>>):

    A description of the document attachments, including names, locations, sizes, and so on.

  • review_status(Option<ReviewStatus>):

    The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

    Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

    Only one version of an SSM document can be in review, or PENDING, at a time.

• On failure, responds with SdkError<GetDocumentError>

impl Client

pub fn get_execution_preview(&self) -> GetExecutionPreviewFluentBuilder

Constructs a fluent builder for the GetExecutionPreview operation.

• The fluent builder is configurable:
  • execution_preview_id(impl Into<String>) / set_execution_preview_id(Option<String>):
    required: true
    

    The ID of the existing execution preview.

    
    
• On success, responds with GetExecutionPreviewOutput with field(s):
  • execution_preview_id(Option<String>):

    The generated ID for the existing execution preview.

  • ended_at(Option<DateTime>):

    A UTC timestamp indicating when the execution preview operation ended.

  • status(Option<ExecutionPreviewStatus>):

    The current status of the execution preview operation.

  • status_message(Option<String>):

    Supplemental information about the current status of the execution preview.

  • execution_preview(Option<ExecutionPreview>):

    Information about the changes that would be made if an execution were run.

• On failure, responds with SdkError<GetExecutionPreviewError>

impl Client

pub fn get_inventory(&self) -> GetInventoryFluentBuilder

Constructs a fluent builder for the GetInventory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(InventoryFilter) / set_filters(Option<Vec::<InventoryFilter>>):
    required: false
    

    One or more filters. Use a filter to return a more specific list of results.

    
    
  • aggregators(InventoryAggregator) / set_aggregators(Option<Vec::<InventoryAggregator>>):
    required: false
    

    Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and Linux managed nodes exist in your inventoried fleet.

    
    
  • result_attributes(ResultAttribute) / set_result_attributes(Option<Vec::<ResultAttribute>>):
    required: false
    

    The list of inventory item types to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with GetInventoryOutput with field(s):
  • entities(Option<Vec::<InventoryResultEntity>>):

    Collection of inventory entities such as a collection of managed node inventory.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<GetInventoryError>

impl Client

pub fn get_inventory_schema(&self) -> GetInventorySchemaFluentBuilder

Constructs a fluent builder for the GetInventorySchema operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The type of inventory item to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • aggregator(bool) / set_aggregator(Option<bool>):
    required: false
    

    Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.

    
    
  • sub_type(bool) / set_sub_type(Option<bool>):
    required: false
    

    Returns the sub-type schema for a specified inventory type.

    
    
• On success, responds with GetInventorySchemaOutput with field(s):
  • schemas(Option<Vec::<InventoryItemSchema>>):

    Inventory schemas returned by the request.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<GetInventorySchemaError>

impl Client

pub fn get_maintenance_window(&self) -> GetMaintenanceWindowFluentBuilder

Constructs a fluent builder for the GetMaintenanceWindow operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window for which you want to retrieve information.

    
    
• On success, responds with GetMaintenanceWindowOutput with field(s):
  • window_id(Option<String>):

    The ID of the created maintenance window.

  • name(Option<String>):

    The name of the maintenance window.

  • description(Option<String>):

    The description of the maintenance window.

  • start_date(Option<String>):

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won’t run before this specified time.

  • end_date(Option<String>):

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won’t run after this specified time.

  • schedule(Option<String>):

    The schedule of the maintenance window in the form of a cron or rate expression.

  • schedule_timezone(Option<String>):

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”. For more information, see the Time Zone Database on the IANA website.

  • schedule_offset(Option<i32>):

    The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

  • next_execution_time(Option<String>):

    The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

  • duration(Option<i32>):

    The duration of the maintenance window in hours.

  • cutoff(i32):

    The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

  • allow_unassociated_targets(bool):

    Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

  • enabled(bool):

    Indicates whether the maintenance window is enabled.

  • created_date(Option<DateTime>):

    The date the maintenance window was created.

  • modified_date(Option<DateTime>):

    The date the maintenance window was last modified.

• On failure, responds with SdkError<GetMaintenanceWindowError>

impl Client

pub fn get_maintenance_window_execution( &self, ) -> GetMaintenanceWindowExecutionFluentBuilder

Constructs a fluent builder for the GetMaintenanceWindowExecution operation.

• The fluent builder is configurable:
  • window_execution_id(impl Into<String>) / set_window_execution_id(Option<String>):
    required: true
    

    The ID of the maintenance window execution that includes the task.

    
    
• On success, responds with GetMaintenanceWindowExecutionOutput with field(s):
  • window_execution_id(Option<String>):

    The ID of the maintenance window execution.

  • task_ids(Option<Vec::<String>>):

    The ID of the task executions from the maintenance window execution.

  • status(Option<MaintenanceWindowExecutionStatus>):

    The status of the maintenance window execution.

  • status_details(Option<String>):

    The details explaining the status. Not available for all status values.

  • start_time(Option<DateTime>):

    The time the maintenance window started running.

  • end_time(Option<DateTime>):

    The time the maintenance window finished running.

• On failure, responds with SdkError<GetMaintenanceWindowExecutionError>

impl Client

pub fn get_maintenance_window_execution_task( &self, ) -> GetMaintenanceWindowExecutionTaskFluentBuilder

Constructs a fluent builder for the GetMaintenanceWindowExecutionTask operation.

• The fluent builder is configurable:
  • window_execution_id(impl Into<String>) / set_window_execution_id(Option<String>):
    required: true
    

    The ID of the maintenance window execution that includes the task.

    
    
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The ID of the specific task execution in the maintenance window task that should be retrieved.

    
    
• On success, responds with GetMaintenanceWindowExecutionTaskOutput with field(s):
  • window_execution_id(Option<String>):

    The ID of the maintenance window execution that includes the task.

  • task_execution_id(Option<String>):

    The ID of the specific task execution in the maintenance window task that was retrieved.

  • task_arn(Option<String>):

    The Amazon Resource Name (ARN) of the task that ran.

  • service_role(Option<String>):

    The role that was assumed when running the task.

  • r#type(Option<MaintenanceWindowTaskType>):

    The type of task that was run.

  • task_parameters(Option<Vec::<HashMap::<String, MaintenanceWindowTaskParameterValueExpression>>>):

    The parameters passed to the task when it was run.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    The map has the following format:

    • Key: string, between 1 and 255 characters

    • Value: an array of strings, each between 1 and 255 characters

  • priority(i32):

    The priority of the task.

  • max_concurrency(Option<String>):

    The defined maximum number of task executions that could be run in parallel.

  • max_errors(Option<String>):

    The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

  • status(Option<MaintenanceWindowExecutionStatus>):

    The status of the task.

  • status_details(Option<String>):

    The details explaining the status. Not available for all status values.

  • start_time(Option<DateTime>):

    The time the task execution started.

  • end_time(Option<DateTime>):

    The time the task execution completed.

  • alarm_configuration(Option<AlarmConfiguration>):

    The details for the CloudWatch alarm you applied to your maintenance window task.

  • triggered_alarms(Option<Vec::<AlarmStateInformation>>):

    The CloudWatch alarms that were invoked by the maintenance window task.

• On failure, responds with SdkError<GetMaintenanceWindowExecutionTaskError>

impl Client

pub fn get_maintenance_window_execution_task_invocation( &self, ) -> GetMaintenanceWindowExecutionTaskInvocationFluentBuilder

Constructs a fluent builder for the GetMaintenanceWindowExecutionTaskInvocation operation.

• The fluent builder is configurable:
  • window_execution_id(impl Into<String>) / set_window_execution_id(Option<String>):
    required: true
    

    The ID of the maintenance window execution for which the task is a part.

    
    
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The ID of the specific task in the maintenance window task that should be retrieved.

    
    
  • invocation_id(impl Into<String>) / set_invocation_id(Option<String>):
    required: true
    

    The invocation ID to retrieve.

    
    
• On success, responds with GetMaintenanceWindowExecutionTaskInvocationOutput with field(s):
  • window_execution_id(Option<String>):

    The maintenance window execution ID.

  • task_execution_id(Option<String>):

    The task execution ID.

  • invocation_id(Option<String>):

    The invocation ID.

  • execution_id(Option<String>):

    The execution ID.

  • task_type(Option<MaintenanceWindowTaskType>):

    Retrieves the task type for a maintenance window.

  • parameters(Option<String>):

    The parameters used at the time that the task ran.

  • status(Option<MaintenanceWindowExecutionStatus>):

    The task status for an invocation.

  • status_details(Option<String>):

    The details explaining the status. Details are only available for certain status values.

  • start_time(Option<DateTime>):

    The time that the task started running on the target.

  • end_time(Option<DateTime>):

    The time that the task finished running on the target.

  • owner_information(Option<String>):

    User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window.

  • window_target_id(Option<String>):

    The maintenance window target ID.

• On failure, responds with SdkError<GetMaintenanceWindowExecutionTaskInvocationError>

impl Client

pub fn get_maintenance_window_task( &self, ) -> GetMaintenanceWindowTaskFluentBuilder

Constructs a fluent builder for the GetMaintenanceWindowTask operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The maintenance window ID that includes the task to retrieve.

    
    
  • window_task_id(impl Into<String>) / set_window_task_id(Option<String>):
    required: true
    

    The maintenance window task ID to retrieve.

    
    
• On success, responds with GetMaintenanceWindowTaskOutput with field(s):
  • window_id(Option<String>):

    The retrieved maintenance window ID.

  • window_task_id(Option<String>):

    The retrieved maintenance window task ID.

  • targets(Option<Vec::<Target>>):

    The targets where the task should run.

  • task_arn(Option<String>):

    The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

  • service_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

  • task_type(Option<MaintenanceWindowTaskType>):

    The type of task to run.

  • task_parameters(Option<HashMap::<String, MaintenanceWindowTaskParameterValueExpression>>):

    The parameters to pass to the task when it runs.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

  • task_invocation_parameters(Option<MaintenanceWindowTaskInvocationParameters>):

    The parameters to pass to the task when it runs.

  • priority(i32):

    The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

  • max_concurrency(Option<String>):

    The maximum number of targets allowed to run this task in parallel.

    For maintenance window tasks without a target specified, you can’t supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn’t affect the running of your task and can be ignored.

  • max_errors(Option<String>):

    The maximum number of errors allowed before the task stops being scheduled.

    For maintenance window tasks without a target specified, you can’t supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn’t affect the running of your task and can be ignored.

  • logging_info(Option<LoggingInfo>):

    The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

    LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

  • name(Option<String>):

    The retrieved task name.

  • description(Option<String>):

    The retrieved task description.

  • cutoff_behavior(Option<MaintenanceWindowTaskCutoffBehavior>):

    The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.

  • alarm_configuration(Option<AlarmConfiguration>):

    The details for the CloudWatch alarm you applied to your maintenance window task.

• On failure, responds with SdkError<GetMaintenanceWindowTaskError>

impl Client

pub fn get_ops_item(&self) -> GetOpsItemFluentBuilder

Constructs a fluent builder for the GetOpsItem operation.

• The fluent builder is configurable:
  • ops_item_id(impl Into<String>) / set_ops_item_id(Option<String>):
    required: true
    

    The ID of the OpsItem that you want to get.

    
    
  • ops_item_arn(impl Into<String>) / set_ops_item_arn(Option<String>):
    required: false
    

    The OpsItem Amazon Resource Name (ARN).

    
    
• On success, responds with GetOpsItemOutput with field(s):
  • ops_item(Option<OpsItem>):

    The OpsItem.

• On failure, responds with SdkError<GetOpsItemError>

impl Client

pub fn get_ops_metadata(&self) -> GetOpsMetadataFluentBuilder

Constructs a fluent builder for the GetOpsMetadata operation.

• The fluent builder is configurable:
  • ops_metadata_arn(impl Into<String>) / set_ops_metadata_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of an OpsMetadata Object to view.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
• On success, responds with GetOpsMetadataOutput with field(s):
  • resource_id(Option<String>):

    The resource ID of the Application Manager application.

  • metadata(Option<HashMap::<String, MetadataValue>>):

    OpsMetadata for an Application Manager application.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<GetOpsMetadataError>

impl Client

pub fn get_ops_summary(&self) -> GetOpsSummaryFluentBuilder

Constructs a fluent builder for the GetOpsSummary operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sync_name(impl Into<String>) / set_sync_name(Option<String>):
    required: false
    

    Specify the name of a resource data sync to get.

    
    
  • filters(OpsFilter) / set_filters(Option<Vec::<OpsFilter>>):
    required: false
    

    Optional filters used to scope down the returned OpsData.

    
    
  • aggregators(OpsAggregator) / set_aggregators(Option<Vec::<OpsAggregator>>):
    required: false
    

    Optional aggregators that return counts of OpsData based on one or more expressions.

    
    
  • result_attributes(OpsResultAttribute) / set_result_attributes(Option<Vec::<OpsResultAttribute>>):
    required: false
    

    The OpsData data type to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with GetOpsSummaryOutput with field(s):
  • entities(Option<Vec::<OpsEntity>>):

    The list of aggregated details and filtered OpsData.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<GetOpsSummaryError>

impl Client

pub fn get_parameter(&self) -> GetParameterFluentBuilder

Constructs a fluent builder for the GetParameter operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.

    To query by parameter label, use “Name”: “name:label”. To query by parameter version, use “Name”: “name:version”.

    For more information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

    
    
  • with_decryption(bool) / set_with_decryption(Option<bool>):
    required: false
    

    Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

    
    
• On success, responds with GetParameterOutput with field(s):
  • parameter(Option<Parameter>):

    Information about a parameter.

• On failure, responds with SdkError<GetParameterError>

impl Client

pub fn get_parameter_history(&self) -> GetParameterHistoryFluentBuilder

Constructs a fluent builder for the GetParameterHistory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN.

    
    
  • with_decryption(bool) / set_with_decryption(Option<bool>):
    required: false
    

    Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with GetParameterHistoryOutput with field(s):
  • parameters(Option<Vec::<ParameterHistory>>):

    A list of parameters returned by the request.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<GetParameterHistoryError>

impl Client

pub fn get_parameters(&self) -> GetParametersFluentBuilder

Constructs a fluent builder for the GetParameters operation.

• The fluent builder is configurable:
  • names(impl Into<String>) / set_names(Option<Vec::<String>>):
    required: true
    

    The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.

    To query by parameter label, use “Name”: “name:label”. To query by parameter version, use “Name”: “name:version”.

    The results for GetParameters requests are listed in alphabetical order in query responses.

    For information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

    
    
  • with_decryption(bool) / set_with_decryption(Option<bool>):
    required: false
    

    Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

    
    
• On success, responds with GetParametersOutput with field(s):
  • parameters(Option<Vec::<Parameter>>):

    A list of details for a parameter.

  • invalid_parameters(Option<Vec::<String>>):

    A list of parameters that aren’t formatted correctly or don’t run during an execution.

• On failure, responds with SdkError<GetParametersError>

impl Client

pub fn get_parameters_by_path(&self) -> GetParametersByPathFluentBuilder

Constructs a fluent builder for the GetParametersByPath operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • path(impl Into<String>) / set_path(Option<String>):
    required: true
    

    The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can’t be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

    
    
  • recursive(bool) / set_recursive(Option<bool>):
    required: false
    

    Retrieve all parameters within a hierarchy.

    If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API operation recursively for /a and view /a/b.

    
    
  • parameter_filters(ParameterStringFilter) / set_parameter_filters(Option<Vec::<ParameterStringFilter>>):
    required: false
    

    Filters to limit the request results.

    The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

    The following Key values aren’t supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

    
    
  • with_decryption(bool) / set_with_decryption(Option<bool>):
    required: false
    

    Retrieve all parameters in a hierarchy with their value decrypted.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
• On success, responds with GetParametersByPathOutput with field(s):
  • parameters(Option<Vec::<Parameter>>):

    A list of parameters found in the specified hierarchy.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<GetParametersByPathError>

impl Client

pub fn get_patch_baseline(&self) -> GetPatchBaselineFluentBuilder

Constructs a fluent builder for the GetPatchBaseline operation.

• The fluent builder is configurable:
  • baseline_id(impl Into<String>) / set_baseline_id(Option<String>):
    required: true
    

    The ID of the patch baseline to retrieve.

    To retrieve information about an Amazon Web Services managed patch baseline, specify the full Amazon Resource Name (ARN) of the baseline. For example, for the baseline AWS-AmazonLinuxDefaultPatchBaseline, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7 instead of pb-0e392de35e7c563b7.

    
    
• On success, responds with GetPatchBaselineOutput with field(s):
  • baseline_id(Option<String>):

    The ID of the retrieved patch baseline.

  • name(Option<String>):

    The name of the patch baseline.

  • operating_system(Option<OperatingSystem>):

    Returns the operating system specified for the patch baseline.

  • global_filters(Option<PatchFilterGroup>):

    A set of global filters used to exclude patches from the baseline.

  • approval_rules(Option<PatchRuleGroup>):

    A set of rules used to include patches in the baseline.

  • approved_patches(Option<Vec::<String>>):

    A list of explicitly approved patches for the baseline.

  • approved_patches_compliance_level(Option<PatchComplianceLevel>):

    Returns the specified compliance severity level for approved patches in the patch baseline.

  • approved_patches_enable_non_security(Option<bool>):

    Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

  • rejected_patches(Option<Vec::<String>>):

    A list of explicitly rejected patches for the baseline.

  • rejected_patches_action(Option<PatchAction>):

    The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

  • patch_groups(Option<Vec::<String>>):

    Patch groups included in the patch baseline.

  • created_date(Option<DateTime>):

    The date the patch baseline was created.

  • modified_date(Option<DateTime>):

    The date the patch baseline was last modified.

  • description(Option<String>):

    A description of the patch baseline.

  • sources(Option<Vec::<PatchSource>>):

    Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

• On failure, responds with SdkError<GetPatchBaselineError>

impl Client

pub fn get_patch_baseline_for_patch_group( &self, ) -> GetPatchBaselineForPatchGroupFluentBuilder

Constructs a fluent builder for the GetPatchBaselineForPatchGroup operation.

• The fluent builder is configurable:
  • patch_group(impl Into<String>) / set_patch_group(Option<String>):
    required: true
    

    The name of the patch group whose patch baseline should be retrieved.

    
    
  • operating_system(OperatingSystem) / set_operating_system(Option<OperatingSystem>):
    required: false
    

    Returns the operating system rule specified for patch groups using the patch baseline.

    
    
• On success, responds with GetPatchBaselineForPatchGroupOutput with field(s):
  • baseline_id(Option<String>):

    The ID of the patch baseline that should be used for the patch group.

  • patch_group(Option<String>):

    The name of the patch group.

  • operating_system(Option<OperatingSystem>):

    The operating system rule specified for patch groups using the patch baseline.

• On failure, responds with SdkError<GetPatchBaselineForPatchGroupError>

impl Client

pub fn get_resource_policies(&self) -> GetResourcePoliciesFluentBuilder

Constructs a fluent builder for the GetResourcePolicies operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the resource to which the policies are attached.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with GetResourcePoliciesOutput with field(s):
  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

  • policies(Option<Vec::<GetResourcePoliciesResponseEntry>>):

    An array of the Policy object.

• On failure, responds with SdkError<GetResourcePoliciesError>

impl Client

pub fn get_service_setting(&self) -> GetServiceSettingFluentBuilder

Constructs a fluent builder for the GetServiceSetting operation.

• The fluent builder is configurable:
  • setting_id(impl Into<String>) / set_setting_id(Option<String>):
    required: true
    

    The ID of the service setting to get. The setting ID can be one of the following.

    • /ssm/appmanager/appmanager-enabled

    • /ssm/automation/customer-script-log-destination

    • /ssm/automation/customer-script-log-group-name

    • /ssm/automation/enable-adaptive-concurrency

    • /ssm/documents/console/public-sharing-permission

    • /ssm/managed-instance/activation-tier

    • /ssm/managed-instance/default-ec2-instance-management-role

    • /ssm/opsinsights/opscenter

    • /ssm/parameter-store/default-parameter-tier

    • /ssm/parameter-store/high-throughput-enabled

    
    
• On success, responds with GetServiceSettingOutput with field(s):
  • service_setting(Option<ServiceSetting>):

    The query result of the current service setting.

• On failure, responds with SdkError<GetServiceSettingError>

impl Client

pub fn label_parameter_version(&self) -> LabelParameterVersionFluentBuilder

Constructs a fluent builder for the LabelParameterVersion operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The parameter name on which you want to attach one or more labels.

    You can’t enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.

    
    
  • parameter_version(i64) / set_parameter_version(Option<i64>):
    required: false
    

    The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.

    
    
  • labels(impl Into<String>) / set_labels(Option<Vec::<String>>):
    required: true
    

    One or more labels to attach to the specified parameter version.

    
    
• On success, responds with LabelParameterVersionOutput with field(s):
  • invalid_labels(Option<Vec::<String>>):

    The label doesn’t meet the requirements. For information about parameter label requirements, see Working with parameter labels in the Amazon Web Services Systems Manager User Guide.

  • parameter_version(i64):

    The version of the parameter that has been labeled.

• On failure, responds with SdkError<LabelParameterVersionError>

impl Client

pub fn list_association_versions(&self) -> ListAssociationVersionsFluentBuilder

Constructs a fluent builder for the ListAssociationVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The association ID for which you want to view all versions.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
• On success, responds with ListAssociationVersionsOutput with field(s):
  • association_versions(Option<Vec::<AssociationVersionInfo>>):

    Information about all versions of the association for the specified association ID.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<ListAssociationVersionsError>

impl Client

pub fn list_associations(&self) -> ListAssociationsFluentBuilder

Constructs a fluent builder for the ListAssociations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • association_filter_list(AssociationFilter) / set_association_filter_list(Option<Vec::<AssociationFilter>>):
    required: false
    

    One or more filters. Use a filter to return a more specific list of results.

    Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the managed node that are part of the Target Attributes ResourceGroup or Tags aren’t returned.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with ListAssociationsOutput with field(s):
  • associations(Option<Vec::<Association>>):

    The associations.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<ListAssociationsError>

impl Client

pub fn list_command_invocations(&self) -> ListCommandInvocationsFluentBuilder

Constructs a fluent builder for the ListCommandInvocations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • command_id(impl Into<String>) / set_command_id(Option<String>):
    required: false
    

    (Optional) The invocations for a specific command ID.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    (Optional) The command execution details for a specific managed node ID.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    (Optional) The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • filters(CommandFilter) / set_filters(Option<Vec::<CommandFilter>>):
    required: false
    

    (Optional) One or more filters. Use a filter to return a more specific list of results.

    
    
  • details(bool) / set_details(Option<bool>):
    required: false
    

    (Optional) If set this returns the response of the command executions and any command output. The default value is false.

    
    
• On success, responds with ListCommandInvocationsOutput with field(s):
  • command_invocations(Option<Vec::<CommandInvocation>>):

    (Optional) A list of all invocations.

  • next_token(Option<String>):

    (Optional) The token for the next set of items to return. (You received this token from a previous call.)

• On failure, responds with SdkError<ListCommandInvocationsError>

impl Client

pub fn list_commands(&self) -> ListCommandsFluentBuilder

Constructs a fluent builder for the ListCommands operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • command_id(impl Into<String>) / set_command_id(Option<String>):
    required: false
    

    (Optional) If provided, lists only the specified command.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: false
    

    (Optional) Lists commands issued against this managed node ID.

    You can’t specify a managed node ID in the same command that you specify Status = Pending. This is because the command hasn’t reached the managed node yet.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    (Optional) The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • filters(CommandFilter) / set_filters(Option<Vec::<CommandFilter>>):
    required: false
    

    (Optional) One or more filters. Use a filter to return a more specific list of results.

    
    
• On success, responds with ListCommandsOutput with field(s):
  • commands(Option<Vec::<Command>>):

    (Optional) The list of commands requested by the user.

  • next_token(Option<String>):

    (Optional) The token for the next set of items to return. (You received this token from a previous call.)

• On failure, responds with SdkError<ListCommandsError>

impl Client

pub fn list_compliance_items(&self) -> ListComplianceItemsFluentBuilder

Constructs a fluent builder for the ListComplianceItems operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(ComplianceStringFilter) / set_filters(Option<Vec::<ComplianceStringFilter>>):
    required: false
    

    One or more compliance filters. Use a filter to return a more specific list of results.

    
    
  • resource_ids(impl Into<String>) / set_resource_ids(Option<Vec::<String>>):
    required: false
    

    The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

    
    
  • resource_types(impl Into<String>) / set_resource_types(Option<Vec::<String>>):
    required: false
    

    The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListComplianceItemsOutput with field(s):
  • compliance_items(Option<Vec::<ComplianceItem>>):

    A list of compliance information for the specified resource ID.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<ListComplianceItemsError>

impl Client

pub fn list_compliance_summaries(&self) -> ListComplianceSummariesFluentBuilder

Constructs a fluent builder for the ListComplianceSummaries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(ComplianceStringFilter) / set_filters(Option<Vec::<ComplianceStringFilter>>):
    required: false
    

    One or more compliance or inventory filters. Use a filter to return a more specific list of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListComplianceSummariesOutput with field(s):
  • compliance_summary_items(Option<Vec::<ComplianceSummaryItem>>):

    A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<ListComplianceSummariesError>

impl Client

pub fn list_document_metadata_history( &self, ) -> ListDocumentMetadataHistoryFluentBuilder

Constructs a fluent builder for the ListDocumentMetadataHistory operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the change template.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The version of the change template.

    
    
  • metadata(DocumentMetadataEnum) / set_metadata(Option<DocumentMetadataEnum>):
    required: true
    

    The type of data for which details are being requested. Currently, the only supported value is DocumentReviews.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListDocumentMetadataHistoryOutput with field(s):
  • name(Option<String>):

    The name of the change template.

  • document_version(Option<String>):

    The version of the change template.

  • author(Option<String>):

    The user ID of the person in the organization who requested the review of the change template.

  • metadata(Option<DocumentMetadataResponseInfo>):

    Information about the response to the change template approval request.

  • next_token(Option<String>):

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

• On failure, responds with SdkError<ListDocumentMetadataHistoryError>

impl Client

pub fn list_document_versions(&self) -> ListDocumentVersionsFluentBuilder

Constructs a fluent builder for the ListDocumentVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the document. You can specify an Amazon Resource Name (ARN).

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with ListDocumentVersionsOutput with field(s):
  • document_versions(Option<Vec::<DocumentVersionInfo>>):

    The document versions.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<ListDocumentVersionsError>

impl Client

pub fn list_documents(&self) -> ListDocumentsFluentBuilder

Constructs a fluent builder for the ListDocuments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • document_filter_list(DocumentFilter) / set_document_filter_list(Option<Vec::<DocumentFilter>>):
    required: false
    

    This data type is deprecated. Instead, use Filters.

    
    
  • filters(DocumentKeyValuesFilter) / set_filters(Option<Vec::<DocumentKeyValuesFilter>>):
    required: false
    

    One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

    This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with ListDocumentsOutput with field(s):
  • document_identifiers(Option<Vec::<DocumentIdentifier>>):

    The names of the SSM documents.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<ListDocumentsError>

impl Client

pub fn list_inventory_entries(&self) -> ListInventoryEntriesFluentBuilder

Constructs a fluent builder for the ListInventoryEntries operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The managed node ID for which you want inventory information.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: true
    

    The type of inventory item for which you want information.

    
    
  • filters(InventoryFilter) / set_filters(Option<Vec::<InventoryFilter>>):
    required: false
    

    One or more filters. Use a filter to return a more specific list of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListInventoryEntriesOutput with field(s):
  • type_name(Option<String>):

    The type of inventory item returned by the request.

  • instance_id(Option<String>):

    The managed node ID targeted by the request to query inventory information.

  • schema_version(Option<String>):

    The inventory schema version used by the managed nodes.

  • capture_time(Option<String>):

    The time that inventory information was collected for the managed nodes.

  • entries(Option<Vec::<HashMap::<String, String>>>):

    A list of inventory items on the managed nodes.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<ListInventoryEntriesError>

impl Client

pub fn list_nodes(&self) -> ListNodesFluentBuilder

Constructs a fluent builder for the ListNodes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sync_name(impl Into<String>) / set_sync_name(Option<String>):
    required: false
    

    The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configurations. Optional for single account/single-Region configurations.

    
    
  • filters(NodeFilter) / set_filters(Option<Vec::<NodeFilter>>):
    required: false
    

    One or more filters. Use a filter to return a more specific list of managed nodes.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListNodesOutput with field(s):
  • nodes(Option<Vec::<Node>>):

    A list of managed nodes that match the specified filter criteria.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<ListNodesError>

impl Client

pub fn list_nodes_summary(&self) -> ListNodesSummaryFluentBuilder

Constructs a fluent builder for the ListNodesSummary operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sync_name(impl Into<String>) / set_sync_name(Option<String>):
    required: false
    

    The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configuration. Optional for single account/single-Region configurations.

    
    
  • filters(NodeFilter) / set_filters(Option<Vec::<NodeFilter>>):
    required: false
    

    One or more filters. Use a filter to generate a summary that matches your specified filter criteria.

    
    
  • aggregators(NodeAggregator) / set_aggregators(Option<Vec::<NodeAggregator>>):
    required: true
    

    Specify one or more aggregators to return a count of managed nodes that match that expression. For example, a count of managed nodes by operating system.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.) The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListNodesSummaryOutput with field(s):
  • summary(Option<Vec::<HashMap::<String, String>>>):

    A collection of objects reporting information about your managed nodes, such as the count of nodes by operating system.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

• On failure, responds with SdkError<ListNodesSummaryError>

impl Client

pub fn list_ops_item_events(&self) -> ListOpsItemEventsFluentBuilder

Constructs a fluent builder for the ListOpsItemEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(OpsItemEventFilter) / set_filters(Option<Vec::<OpsItemEventFilter>>):
    required: false
    

    One or more OpsItem filters. Use a filter to return a more specific list of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
• On success, responds with ListOpsItemEventsOutput with field(s):
  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

  • summaries(Option<Vec::<OpsItemEventSummary>>):

    A list of event information for the specified OpsItems.

• On failure, responds with SdkError<ListOpsItemEventsError>

impl Client

pub fn list_ops_item_related_items( &self, ) -> ListOpsItemRelatedItemsFluentBuilder

Constructs a fluent builder for the ListOpsItemRelatedItems operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • ops_item_id(impl Into<String>) / set_ops_item_id(Option<String>):
    required: false
    

    The ID of the OpsItem for which you want to list all related-item resources.

    
    
  • filters(OpsItemRelatedItemsFilter) / set_filters(Option<Vec::<OpsItemRelatedItemsFilter>>):
    required: false
    

    One or more OpsItem filters. Use a filter to return a more specific list of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return. (You received this token from a previous call.)

    
    
• On success, responds with ListOpsItemRelatedItemsOutput with field(s):
  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

  • summaries(Option<Vec::<OpsItemRelatedItemSummary>>):

    A list of related-item resources for the specified OpsItem.

• On failure, responds with SdkError<ListOpsItemRelatedItemsError>

impl Client

pub fn list_ops_metadata(&self) -> ListOpsMetadataFluentBuilder

Constructs a fluent builder for the ListOpsMetadata operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(OpsMetadataFilter) / set_filters(Option<Vec::<OpsMetadataFilter>>):
    required: false
    

    One or more filters to limit the number of OpsMetadata objects returned by the call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
• On success, responds with ListOpsMetadataOutput with field(s):
  • ops_metadata_list(Option<Vec::<OpsMetadata>>):

    Returns a list of OpsMetadata objects.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<ListOpsMetadataError>

impl Client

pub fn list_resource_compliance_summaries( &self, ) -> ListResourceComplianceSummariesFluentBuilder

Constructs a fluent builder for the ListResourceComplianceSummaries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(ComplianceStringFilter) / set_filters(Option<Vec::<ComplianceStringFilter>>):
    required: false
    

    One or more filters. Use a filter to return a more specific list of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListResourceComplianceSummariesOutput with field(s):
  • resource_compliance_summary_items(Option<Vec::<ResourceComplianceSummaryItem>>):

    A summary count for specified or targeted managed nodes. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<ListResourceComplianceSummariesError>

impl Client

pub fn list_resource_data_sync(&self) -> ListResourceDataSyncFluentBuilder

Constructs a fluent builder for the ListResourceDataSync operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sync_type(impl Into<String>) / set_sync_type(Option<String>):
    required: false
    

    View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from Organizations or from multiple Amazon Web Services Regions.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to start the list. Use this token to get the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListResourceDataSyncOutput with field(s):
  • resource_data_sync_items(Option<Vec::<ResourceDataSyncItem>>):

    A list of your current resource data sync configurations and their statuses.

  • next_token(Option<String>):

    The token for the next set of items to return. Use this token to get the next set of results.

• On failure, responds with SdkError<ListResourceDataSyncError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_type(ResourceTypeForTagging) / set_resource_type(Option<ResourceTypeForTagging>):
    required: true
    

    Returns a list of tags for a specific resource type.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The resource ID for which you want to see a list of tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tag_list(Option<Vec::<Tag>>):

    A list of tags.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn modify_document_permission( &self, ) -> ModifyDocumentPermissionFluentBuilder

Constructs a fluent builder for the ModifyDocumentPermission operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the document that you want to share.

    
    
  • permission_type(DocumentPermissionType) / set_permission_type(Option<DocumentPermissionType>):
    required: true
    

    The permission type for the document. The permission type can be Share.

    
    
  • account_ids_to_add(impl Into<String>) / set_account_ids_to_add(Option<Vec::<String>>):
    required: false
    

    The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or All.

    
    
  • account_ids_to_remove(impl Into<String>) / set_account_ids_to_remove(Option<Vec::<String>>):
    required: false
    

    The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an ID to add and the same ID to remove, the system removes access to the document.

    
    
  • shared_document_version(impl Into<String>) / set_shared_document_version(Option<String>):
    required: false
    

    (Optional) The version of the document to share. If it isn’t specified, the system choose the Default version to share.

    
    
• On success, responds with ModifyDocumentPermissionOutput
• On failure, responds with SdkError<ModifyDocumentPermissionError>

impl Client

pub fn put_compliance_items(&self) -> PutComplianceItemsFluentBuilder

Constructs a fluent builder for the PutComplianceItems operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    Specify an ID for this resource. For a managed node, this is the node ID.

    
    
  • resource_type(impl Into<String>) / set_resource_type(Option<String>):
    required: true
    

    Specify the type of resource. ManagedInstance is currently the only supported resource type.

    
    
  • compliance_type(impl Into<String>) / set_compliance_type(Option<String>):
    required: true
    

    Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

    
    
  • execution_summary(ComplianceExecutionSummary) / set_execution_summary(Option<ComplianceExecutionSummary>):
    required: true
    

    A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd’T’HH:mm:ss’Z’

    
    
  • items(ComplianceItemEntry) / set_items(Option<Vec::<ComplianceItemEntry>>):
    required: true
    

    Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, and so on.

    
    
  • item_content_hash(impl Into<String>) / set_item_content_hash(Option<String>):
    required: false
    

    MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

    
    
  • upload_type(ComplianceUploadType) / set_upload_type(Option<ComplianceUploadType>):
    required: false
    

    The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

    In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

    This attribute is only valid for association compliance.

    
    
• On success, responds with PutComplianceItemsOutput
• On failure, responds with SdkError<PutComplianceItemsError>

impl Client

pub fn put_inventory(&self) -> PutInventoryFluentBuilder

Constructs a fluent builder for the PutInventory operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    An managed node ID where you want to add or update inventory items.

    
    
  • items(InventoryItem) / set_items(Option<Vec::<InventoryItem>>):
    required: true
    

    The inventory items that you want to add or update on managed nodes.

    
    
• On success, responds with PutInventoryOutput with field(s):
  • message(Option<String>):

    Information about the request.

• On failure, responds with SdkError<PutInventoryError>

impl Client

pub fn put_parameter(&self) -> PutParameterFluentBuilder

Constructs a fluent builder for the PutParameter operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The fully qualified name of the parameter that you want to add to the system.

    You can’t enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.

    The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13

    Naming Constraints:

    • Parameter names are case sensitive.

    • A parameter name must be unique within an Amazon Web Services Region

    • A parameter name can’t be prefixed with “aws” or “ssm” (case-insensitive).

    • Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-

      In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: /Dev/Production/East/Project-ABC/MyParameter

    • A parameter name can’t include spaces.

    • Parameter hierarchies are limited to a maximum depth of fifteen levels.

    For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

    The maximum length constraint of 2048 characters listed below includes 1037 characters reserved for internal use by Systems Manager. The maximum length for a parameter name that you create is 1011 characters. This includes the characters in the ARN that precede the name you specify, such as arn:aws:ssm:us-east-2:111122223333:parameter/.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Information about the parameter that you want to add to the system. Optional but recommended.

    Don’t enter personally identifiable information in this field.

    
    
  • value(impl Into<String>) / set_value(Option<String>):
    required: true
    

    The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.

    Parameters can’t be referenced or nested in the values of other parameters. You can’t include values wrapped in double brackets {{}} or {{ssm:parameter-name}} in a parameter value.

    
    
  • r#type(ParameterType) / set_type(Option<ParameterType>):
    required: false
    

    The type of parameter that you want to add to the system.

    SecureString isn’t currently supported for CloudFormation templates.

    Items in a StringList must be separated by a comma (,). You can’t use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.

    Specifying a parameter type isn’t required when updating a parameter. You must specify a parameter type when creating a parameter.

    
    
  • key_id(impl Into<String>) / set_key_id(Option<String>):
    required: false
    

    The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the SecureString data type.

    If you don’t specify a key ID, the system uses the default key associated with your Amazon Web Services account which is not as secure as using a custom key.

    • To use a custom KMS key, choose the SecureString data type with the Key ID parameter.

    
    
  • overwrite(bool) / set_overwrite(Option<bool>):
    required: false
    

    Overwrite an existing parameter. The default value is false.

    
    
  • allowed_pattern(impl Into<String>) / set_allowed_pattern(Option<String>):
    required: false
    

    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:

    • Key=Resource,Value=S3bucket

    • Key=OS,Value=Windows

    • Key=ParameterType,Value=LicenseKey

    To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation.

    
    
  • tier(ParameterTier) / set_tier(Option<ParameterTier>):
    required: false
    

    The parameter tier to assign to a parameter.

    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can’t be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account. Standard parameters are offered at no additional cost.

    Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see Managing parameter tiers in the Amazon Web Services Systems Manager User Guide.

    You can change a standard parameter to an advanced parameter any time. But you can’t revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.

    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.

    Using the Default Tier Configuration

    In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don’t specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.

    The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:

    • Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.

    • Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.

      If the request doesn’t include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.

      This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.

    Options that require an advanced parameter include the following:

    • The content size of the parameter is more than 4 KB.

    • The parameter uses a parameter policy.

    • More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.

    For more information about configuring the default tier option, see Specifying a default parameter tier in the Amazon Web Services Systems Manager User Guide.

    
    
  • policies(impl Into<String>) / set_policies(Option<String>):
    required: false
    

    One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in Amazon Web Services Systems Manager supports the following policy types:

    Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter doesn’t affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

    ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

    NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn’t been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn’t been changed.

    All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.

    
    
  • data_type(impl Into<String>) / set_data_type(Option<String>):
    required: false
    

    The data type for a String parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.

    The following data type values are supported.

    • text

    • aws:ec2:image

    • aws:ssm:integration

    When you create a String parameter and specify aws:ec2:image, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your Amazon Web Services account.

    If the action is successful, the service sends back an HTTP 200 response which indicates a successful PutParameter call for all cases except for data type aws:ec2:image. If you call PutParameter with aws:ec2:image data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The aws:ec2:image value is validated asynchronously, and the PutParameter call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your aws:ec2:image parameters are created successfully, see Setting up notifications or trigger actions based on Parameter Store events. For more information about AMI format validation , see Native parameter support for Amazon Machine Image IDs.

    
    
• On success, responds with PutParameterOutput with field(s):
  • version(i64):

    The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API operations or in Systems Manager documents (SSM documents). By default, if you don’t specify a specific version, the system returns the latest parameter value when a parameter is called.

  • tier(Option<ParameterTier>):

    The tier assigned to the parameter.

• On failure, responds with SdkError<PutParameterError>

impl Client

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the resource to which you want to attach a policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    A policy you want to associate with a resource.

    
    
  • policy_id(impl Into<String>) / set_policy_id(Option<String>):
    required: false
    

    The policy ID.

    
    
  • policy_hash(impl Into<String>) / set_policy_hash(Option<String>):
    required: false
    

    ID of the current policy version. The hash helps to prevent a situation where multiple users attempt to overwrite a policy. You must provide this hash when updating or deleting a policy.

    
    
• On success, responds with PutResourcePolicyOutput with field(s):
  • policy_id(Option<String>):

    The policy ID. To update a policy, you must specify PolicyId and PolicyHash.

  • policy_hash(Option<String>):

    ID of the current policy version.

• On failure, responds with SdkError<PutResourcePolicyError>

impl Client

pub fn register_default_patch_baseline( &self, ) -> RegisterDefaultPatchBaselineFluentBuilder

Constructs a fluent builder for the RegisterDefaultPatchBaseline operation.

• The fluent builder is configurable:
  • baseline_id(impl Into<String>) / set_baseline_id(Option<String>):
    required: true
    

    The ID of the patch baseline that should be the default patch baseline.

    
    
• On success, responds with RegisterDefaultPatchBaselineOutput with field(s):
  • baseline_id(Option<String>):

    The ID of the default patch baseline.

• On failure, responds with SdkError<RegisterDefaultPatchBaselineError>

impl Client

pub fn register_patch_baseline_for_patch_group( &self, ) -> RegisterPatchBaselineForPatchGroupFluentBuilder

Constructs a fluent builder for the RegisterPatchBaselineForPatchGroup operation.

• The fluent builder is configurable:
  • baseline_id(impl Into<String>) / set_baseline_id(Option<String>):
    required: true
    

    The ID of the patch baseline to register with the patch group.

    
    
  • patch_group(impl Into<String>) / set_patch_group(Option<String>):
    required: true
    

    The name of the patch group to be registered with the patch baseline.

    
    
• On success, responds with RegisterPatchBaselineForPatchGroupOutput with field(s):
  • baseline_id(Option<String>):

    The ID of the patch baseline the patch group was registered with.

  • patch_group(Option<String>):

    The name of the patch group registered with the patch baseline.

• On failure, responds with SdkError<RegisterPatchBaselineForPatchGroupError>

impl Client

pub fn register_target_with_maintenance_window( &self, ) -> RegisterTargetWithMaintenanceWindowFluentBuilder

Constructs a fluent builder for the RegisterTargetWithMaintenanceWindow operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window the target should be registered with.

    
    
  • resource_type(MaintenanceWindowResourceType) / set_resource_type(Option<MaintenanceWindowResourceType>):
    required: true
    

    The type of target being registered with the maintenance window.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: true
    

    The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.

    If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

    You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

    Example 1: Specify managed node IDs

    Key=InstanceIds,Values= , ,

    Example 2: Use tag key-pairs applied to managed nodes

    Key=tag: ,Values= ,

    Example 3: Use tag-keys applied to managed nodes

    Key=tag-key,Values= ,

    Example 4: Use resource group names

    Key=resource-groups:Name,Values=

    Example 5: Use filters for resource group types

    Key=resource-groups:ResourceTypeFilters,Values= ,

    For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

    Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

    For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.

    
    
  • owner_information(impl Into<String>) / set_owner_information(Option<String>):
    required: false
    

    User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    An optional name for the target.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the target.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    User-provided idempotency token.

    
    
• On success, responds with RegisterTargetWithMaintenanceWindowOutput with field(s):
  • window_target_id(Option<String>):

    The ID of the target definition in this maintenance window.

• On failure, responds with SdkError<RegisterTargetWithMaintenanceWindowError>

impl Client

pub fn register_task_with_maintenance_window( &self, ) -> RegisterTaskWithMaintenanceWindowFluentBuilder

Constructs a fluent builder for the RegisterTaskWithMaintenanceWindow operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window the task should be added to.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: false
    

    The targets (either managed nodes or maintenance window targets).

    One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

    Specify managed nodes using the following format:

    Key=InstanceIds,Values= ,

    Specify maintenance window targets using the following format:

    Key=WindowTargetIds,Values= ,

    
    
  • task_arn(impl Into<String>) / set_task_arn(Option<String>):
    required: true
    

    The ARN of the task to run.

    
    
  • service_role_arn(impl Into<String>) / set_service_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

    
    
  • task_type(MaintenanceWindowTaskType) / set_task_type(Option<MaintenanceWindowTaskType>):
    required: true
    

    The type of task being registered.

    
    
  • task_parameters(impl Into<String>, MaintenanceWindowTaskParameterValueExpression) / set_task_parameters(Option<HashMap::<String, MaintenanceWindowTaskParameterValueExpression>>):
    required: false
    

    The parameters that should be passed to the task when it is run.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    
    
  • task_invocation_parameters(MaintenanceWindowTaskInvocationParameters) / set_task_invocation_parameters(Option<MaintenanceWindowTaskInvocationParameters>):
    required: false
    

    The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

    The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

    
    
  • max_concurrency(impl Into<String>) / set_max_concurrency(Option<String>):
    required: false
    

    The maximum number of targets this task can be run for, in parallel.

    Although this element is listed as “Required: No”, a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

    For maintenance window tasks without a target specified, you can’t supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn’t affect the running of your task.

    
    
  • max_errors(impl Into<String>) / set_max_errors(Option<String>):
    required: false
    

    The maximum number of errors allowed before this task stops being scheduled.

    Although this element is listed as “Required: No”, a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

    For maintenance window tasks without a target specified, you can’t supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn’t affect the running of your task.

    
    
  • logging_info(LoggingInfo) / set_logging_info(Option<LoggingInfo>):
    required: false
    

    A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

    LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    An optional name for the task.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the task.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    User-provided idempotency token.

    
    
  • cutoff_behavior(MaintenanceWindowTaskCutoffBehavior) / set_cutoff_behavior(Option<MaintenanceWindowTaskCutoffBehavior>):
    required: false
    

    Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

    • CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

    • CANCEL_TASK:

      • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

      • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

      The status for tasks that are not completed is TIMED_OUT.

    
    
  • alarm_configuration(AlarmConfiguration) / set_alarm_configuration(Option<AlarmConfiguration>):
    required: false
    

    The CloudWatch alarm you want to apply to your maintenance window task.

    
    
• On success, responds with RegisterTaskWithMaintenanceWindowOutput with field(s):
  • window_task_id(Option<String>):

    The ID of the task in the maintenance window.

• On failure, responds with SdkError<RegisterTaskWithMaintenanceWindowError>

impl Client

pub fn remove_tags_from_resource(&self) -> RemoveTagsFromResourceFluentBuilder

Constructs a fluent builder for the RemoveTagsFromResource operation.

• The fluent builder is configurable:
  • resource_type(ResourceTypeForTagging) / set_resource_type(Option<ResourceTypeForTagging>):
    required: true
    

    The type of resource from which you want to remove a tag.

    The ManagedInstance type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number . For example, mi-1a2b3c4d5e6f.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The ID of the resource from which you want to remove tags. For example:

    ManagedInstance: mi-012345abcde

    MaintenanceWindow: mw-012345abcde

    Automation: example-c160-4567-8519-012345abcde

    PatchBaseline: pb-012345abcde

    OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager.

    For the Document and Parameter values, use the name of the resource.

    The ManagedInstance type for this API operation is only for on-premises managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Tag keys that you want to remove from the specified resource.

    
    
• On success, responds with RemoveTagsFromResourceOutput
• On failure, responds with SdkError<RemoveTagsFromResourceError>

impl Client

pub fn reset_service_setting(&self) -> ResetServiceSettingFluentBuilder

Constructs a fluent builder for the ResetServiceSetting operation.

• The fluent builder is configurable:
  • setting_id(impl Into<String>) / set_setting_id(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.

    • /ssm/appmanager/appmanager-enabled

    • /ssm/automation/customer-script-log-destination

    • /ssm/automation/customer-script-log-group-name

    • /ssm/automation/enable-adaptive-concurrency

    • /ssm/documents/console/public-sharing-permission

    • /ssm/managed-instance/activation-tier

    • /ssm/managed-instance/default-ec2-instance-management-role

    • /ssm/opsinsights/opscenter

    • /ssm/parameter-store/default-parameter-tier

    • /ssm/parameter-store/high-throughput-enabled

    
    
• On success, responds with ResetServiceSettingOutput with field(s):
  • service_setting(Option<ServiceSetting>):

    The current, effective service setting after calling the ResetServiceSetting API operation.

• On failure, responds with SdkError<ResetServiceSettingError>

impl Client

pub fn resume_session(&self) -> ResumeSessionFluentBuilder

Constructs a fluent builder for the ResumeSession operation.

• The fluent builder is configurable:
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The ID of the disconnected session to resume.

    
    
• On success, responds with ResumeSessionOutput with field(s):
  • session_id(Option<String>):

    The ID of the session.

  • token_value(Option<String>):

    An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.

  • stream_url(Option<String>):

    A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the managed node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

    region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

    session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

• On failure, responds with SdkError<ResumeSessionError>

impl Client

pub fn send_automation_signal(&self) -> SendAutomationSignalFluentBuilder

Constructs a fluent builder for the SendAutomationSignal operation.

• The fluent builder is configurable:
  • automation_execution_id(impl Into<String>) / set_automation_execution_id(Option<String>):
    required: true
    

    The unique identifier for an existing Automation execution that you want to send the signal to.

    
    
  • signal_type(SignalType) / set_signal_type(Option<SignalType>):
    required: true
    

    The type of signal to send to an Automation execution.

    
    
  • payload(impl Into<String>, Vec::<String>) / set_payload(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    The data sent with the signal. The data schema depends on the type of signal used in the request.

    For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

    Comment=“Looks good”

    For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

    StepName=“step1”

    For the StopStep signal type, you must send the step execution ID as the payload. For example:

    StepExecutionId=“97fff367-fc5a-4299-aed8-0123456789ab”

    
    
• On success, responds with SendAutomationSignalOutput
• On failure, responds with SdkError<SendAutomationSignalError>

impl Client

pub fn send_command(&self) -> SendCommandFluentBuilder

Constructs a fluent builder for the SendCommand operation.

• The fluent builder is configurable:
  • instance_ids(impl Into<String>) / set_instance_ids(Option<Vec::<String>>):
    required: false
    

    The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs.

    To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once.

    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: false
    

    An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.

    To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.

    For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.

    
    
  • document_name(impl Into<String>) / set_document_name(Option<String>):
    required: true
    

    The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.

    If you specify a document name or ARN that hasn’t been shared with your account, you receive an InvalidDocument error.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don’t need to use the backslash. For example:

    –document-version “$DEFAULT”

    –document-version “$LATEST”

    –document-version “3”

    
    
  • document_hash(impl Into<String>) / set_document_hash(Option<String>):
    required: false
    

    The Sha256 or Sha1 hash created by the system when the document was created.

    Sha1 hashes have been deprecated.

    
    
  • document_hash_type(DocumentHashType) / set_document_hash_type(Option<DocumentHashType>):
    required: false
    

    Sha256 or Sha1.

    Sha1 hashes have been deprecated.

    
    
  • timeout_seconds(i32) / set_timeout_seconds(Option<i32>):
    required: false
    

    If this time is reached and the command hasn’t already started running, it won’t run.

    
    
  • comment(impl Into<String>) / set_comment(Option<String>):
    required: false
    

    User-specified information about the command, such as a brief description of what the command should do.

    
    
  • parameters(impl Into<String>, Vec::<String>) / set_parameters(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    The required and optional parameters specified in the document being run.

    
    
  • output_s3_region(impl Into<String>) / set_output_s3_region(Option<String>):
    required: false
    

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

    
    
  • output_s3_bucket_name(impl Into<String>) / set_output_s3_bucket_name(Option<String>):
    required: false
    

    The name of the S3 bucket where command execution responses should be stored.

    
    
  • output_s3_key_prefix(impl Into<String>) / set_output_s3_key_prefix(Option<String>):
    required: false
    

    The directory structure within the S3 bucket where the responses should be stored.

    
    
  • max_concurrency(impl Into<String>) / set_max_concurrency(Option<String>):
    required: false
    

    (Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

    
    
  • max_errors(impl Into<String>) / set_max_errors(Option<String>):
    required: false
    

    The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

    
    
  • service_role_arn(impl Into<String>) / set_service_role_arn(Option<String>):
    required: false
    

    The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

    This role must provide the sns:Publish permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

    
    
  • notification_config(NotificationConfig) / set_notification_config(Option<NotificationConfig>):
    required: false
    

    Configurations for sending notifications.

    
    
  • cloud_watch_output_config(CloudWatchOutputConfig) / set_cloud_watch_output_config(Option<CloudWatchOutputConfig>):
    required: false
    

    Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a tool in Amazon Web Services Systems Manager.

    
    
  • alarm_configuration(AlarmConfiguration) / set_alarm_configuration(Option<AlarmConfiguration>):
    required: false
    

    The CloudWatch alarm you want to apply to your command.

    
    
• On success, responds with SendCommandOutput with field(s):
  • command(Option<Command>):

    The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.

• On failure, responds with SdkError<SendCommandError>

impl Client

pub fn start_associations_once(&self) -> StartAssociationsOnceFluentBuilder

Constructs a fluent builder for the StartAssociationsOnce operation.

• The fluent builder is configurable:
  • association_ids(impl Into<String>) / set_association_ids(Option<Vec::<String>>):
    required: true
    

    The association IDs that you want to run immediately and only one time.

    
    
• On success, responds with StartAssociationsOnceOutput
• On failure, responds with SdkError<StartAssociationsOnceError>

impl Client

pub fn start_automation_execution( &self, ) -> StartAutomationExecutionFluentBuilder

Constructs a fluent builder for the StartAutomationExecution operation.

• The fluent builder is configurable:
  • document_name(impl Into<String>) / set_document_name(Option<String>):
    required: true
    

    The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Sharing SSM documents in the Amazon Web Services Systems Manager User Guide.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The version of the Automation runbook to use for this execution.

    
    
  • parameters(impl Into<String>, Vec::<String>) / set_parameters(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can’t be reused.

    
    
  • mode(ExecutionMode) / set_mode(Option<ExecutionMode>):
    required: false
    

    The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

    
    
  • target_parameter_name(impl Into<String>) / set_target_parameter_name(Option<String>):
    required: false
    

    The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: false
    

    A key-value mapping to target resources. Required if you specify TargetParameterName.

    If both this parameter and the TargetLocation:Targets parameter are supplied, TargetLocation:Targets takes precedence.

    
    
  • target_maps(HashMap::<String, Vec::<String>>) / set_target_maps(Option<Vec::<HashMap::<String, Vec::<String>>>>):
    required: false
    

    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can’t be specified together.

    
    
  • max_concurrency(impl Into<String>) / set_max_concurrency(Option<String>):
    required: false
    

    The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

    If both this parameter and the TargetLocation:TargetsMaxConcurrency are supplied, TargetLocation:TargetsMaxConcurrency takes precedence.

    
    
  • max_errors(impl Into<String>) / set_max_errors(Option<String>):
    required: false
    

    The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

    Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won’t be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

    If this parameter and the TargetLocation:TargetsMaxErrors parameter are both supplied, TargetLocation:TargetsMaxErrors takes precedence.

    
    
  • target_locations(TargetLocation) / set_target_locations(Option<Vec::<TargetLocation>>):
    required: false
    

    A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see Running automations in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

    • Key=environment,Value=test

    • Key=OS,Value=Windows

    The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartAutomationExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing automation configuration.

    
    
  • alarm_configuration(AlarmConfiguration) / set_alarm_configuration(Option<AlarmConfiguration>):
    required: false
    

    The CloudWatch alarm you want to apply to your automation.

    
    
  • target_locations_url(impl Into<String>) / set_target_locations_url(Option<String>):
    required: false
    

    Specify a publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported.

    
    
• On success, responds with StartAutomationExecutionOutput with field(s):
  • automation_execution_id(Option<String>):

    The unique ID of a newly scheduled automation execution.

• On failure, responds with SdkError<StartAutomationExecutionError>

impl Client

pub fn start_change_request_execution( &self, ) -> StartChangeRequestExecutionFluentBuilder

Constructs a fluent builder for the StartChangeRequestExecution operation.

• The fluent builder is configurable:
  • scheduled_time(DateTime) / set_scheduled_time(Option<DateTime>):
    required: false
    

    The date and time specified in the change request to run the Automation runbooks.

    The Automation runbooks specified for the runbook workflow can’t run until all required approvals for the change request have been received.

    
    
  • document_name(impl Into<String>) / set_document_name(Option<String>):
    required: true
    

    The name of the change template document to run during the runbook workflow.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The version of the change template document to run during the runbook workflow.

    
    
  • parameters(impl Into<String>, Vec::<String>) / set_parameters(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    A key-value map of parameters that match the declared parameters in the change template document.

    
    
  • change_request_name(impl Into<String>) / set_change_request_name(Option<String>):
    required: false
    

    The name of the change request associated with the runbook workflow to be run.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can’t be reused.

    
    
  • auto_approve(bool) / set_auto_approve(Option<bool>):
    required: false
    

    Indicates whether the change request can be approved automatically without the need for manual approvals.

    If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

    Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don’t, the change won’t be processed until the calendar state is again OPEN.

    
    
  • runbooks(Runbook) / set_runbooks(Option<Vec::<Runbook>>):
    required: true
    

    Information about the Automation runbooks that are run during the runbook workflow.

    The Automation runbooks specified for the runbook workflow can’t run until all required approvals for the change request have been received.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

    • Key=Environment,Value=Production

    • Key=Region,Value=us-east-2

    The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.

    
    
  • scheduled_end_time(DateTime) / set_scheduled_end_time(Option<DateTime>):
    required: false
    

    The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

    
    
  • change_details(impl Into<String>) / set_change_details(Option<String>):
    required: false
    

    User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

    
    
• On success, responds with StartChangeRequestExecutionOutput with field(s):
  • automation_execution_id(Option<String>):

    The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)

• On failure, responds with SdkError<StartChangeRequestExecutionError>

impl Client

pub fn start_execution_preview(&self) -> StartExecutionPreviewFluentBuilder

Constructs a fluent builder for the StartExecutionPreview operation.

• The fluent builder is configurable:
  • document_name(impl Into<String>) / set_document_name(Option<String>):
    required: true
    

    The name of the Automation runbook to run. The result of the execution preview indicates what the impact would be of running this runbook.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The version of the Automation runbook to run. The default value is $DEFAULT.

    
    
  • execution_inputs(ExecutionInputs) / set_execution_inputs(Option<ExecutionInputs>):
    required: false
    

    Information about the inputs that can be specified for the preview operation.

    
    
• On success, responds with StartExecutionPreviewOutput with field(s):
  • execution_preview_id(Option<String>):

    The ID of the execution preview generated by the system.

• On failure, responds with SdkError<StartExecutionPreviewError>

impl Client

pub fn start_session(&self) -> StartSessionFluentBuilder

Constructs a fluent builder for the StartSession operation.

• The fluent builder is configurable:
  • target(impl Into<String>) / set_target(Option<String>):
    required: true
    

    The managed node to connect to for the session.

    
    
  • document_name(impl Into<String>) / set_document_name(Option<String>):
    required: false
    

    The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.

    
    
  • reason(impl Into<String>) / set_reason(Option<String>):
    required: false
    

    The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

    
    
  • parameters(impl Into<String>, Vec::<String>) / set_parameters(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see Create a Session Manager preferences document in the Amazon Web Services Systems Manager User Guide.

    
    
• On success, responds with StartSessionOutput with field(s):
  • session_id(Option<String>):

    The ID of the session.

  • token_value(Option<String>):

    An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session’s token.

  • stream_url(Option<String>):

    A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

    region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

    session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

• On failure, responds with SdkError<StartSessionError>

impl Client

pub fn stop_automation_execution(&self) -> StopAutomationExecutionFluentBuilder

Constructs a fluent builder for the StopAutomationExecution operation.

• The fluent builder is configurable:
  • automation_execution_id(impl Into<String>) / set_automation_execution_id(Option<String>):
    required: true
    

    The execution ID of the Automation to stop.

    
    
  • r#type(StopType) / set_type(Option<StopType>):
    required: false
    

    The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.

    
    
• On success, responds with StopAutomationExecutionOutput
• On failure, responds with SdkError<StopAutomationExecutionError>

impl Client

pub fn terminate_session(&self) -> TerminateSessionFluentBuilder

Constructs a fluent builder for the TerminateSession operation.

• The fluent builder is configurable:
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The ID of the session to terminate.

    
    
• On success, responds with TerminateSessionOutput with field(s):
  • session_id(Option<String>):

    The ID of the session that has been terminated.

• On failure, responds with SdkError<TerminateSessionError>

impl Client

pub fn unlabel_parameter_version(&self) -> UnlabelParameterVersionFluentBuilder

Constructs a fluent builder for the UnlabelParameterVersion operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the parameter from which you want to delete one or more labels.

    You can’t enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.

    
    
  • parameter_version(i64) / set_parameter_version(Option<i64>):
    required: true
    

    The specific version of the parameter which you want to delete one or more labels from. If it isn’t present, the call will fail.

    
    
  • labels(impl Into<String>) / set_labels(Option<Vec::<String>>):
    required: true
    

    One or more labels to delete from the specified parameter version.

    
    
• On success, responds with UnlabelParameterVersionOutput with field(s):
  • removed_labels(Option<Vec::<String>>):

    A list of all labels deleted from the parameter.

  • invalid_labels(Option<Vec::<String>>):

    The labels that aren’t attached to the given parameter version.

• On failure, responds with SdkError<UnlabelParameterVersionError>

impl Client

pub fn update_association(&self) -> UpdateAssociationFluentBuilder

Constructs a fluent builder for the UpdateAssociation operation.

• The fluent builder is configurable:
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID of the association you want to update.

    
    
  • parameters(impl Into<String>, Vec::<String>) / set_parameters(Option<HashMap::<String, Vec::<String>>>):
    required: false
    

    The parameters you want to update for the association. If you create a parameter using Parameter Store, a tool in Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The document version you want update for the association.

    State Manager doesn’t support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

    
    
  • schedule_expression(impl Into<String>) / set_schedule_expression(Option<String>):
    required: false
    

    The cron expression used to schedule the association that you want to update.

    
    
  • output_location(InstanceAssociationOutputLocation) / set_output_location(Option<InstanceAssociationOutputLocation>):
    required: false
    

    An S3 bucket where you want to store the results of this request.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.

    You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.

    For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:

    arn:aws:ssm:region:account-id:document/document-name

    For example:

    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

    For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: false
    

    The targets of the association.

    
    
  • association_name(impl Into<String>) / set_association_name(Option<String>):
    required: false
    

    The name of the association that you want to update.

    
    
  • association_version(impl Into<String>) / set_association_version(Option<String>):
    required: false
    

    This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

    
    
  • automation_target_parameter_name(impl Into<String>) / set_automation_target_parameter_name(Option<String>):
    required: false
    

    Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.

    
    
  • max_errors(impl Into<String>) / set_max_errors(Option<String>):
    required: false
    

    The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

    Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won’t be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    
    
  • max_concurrency(impl Into<String>) / set_max_concurrency(Option<String>):
    required: false
    

    The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

    If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

    
    
  • compliance_severity(AssociationComplianceSeverity) / set_compliance_severity(Option<AssociationComplianceSeverity>):
    required: false
    

    The severity level to assign to the association.

    
    
  • sync_compliance(AssociationSyncCompliance) / set_sync_compliance(Option<AssociationSyncCompliance>):
    required: false
    

    The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn’t run successfully, the association is NON-COMPLIANT.

    In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn’t managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

    By default, all associations use AUTO mode.

    
    
  • apply_only_at_cron_interval(bool) / set_apply_only_at_cron_interval(Option<bool>):
    required: false
    

    By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don’t want an association to run immediately after you update it. This parameter isn’t supported for rate expressions.

    If you chose this option when you created an association and later you edit that association or you make changes to the SSM document on which that association is based (by using the Documents page in the console), State Manager applies the association at the next specified cron interval. For example, if you chose the Latest version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously selected this option. If this option wasn’t selected, State Manager immediately runs the association.

    You can reset this option. To do so, specify the no-apply-only-at-cron-interval parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.

    
    
  • calendar_names(impl Into<String>) / set_calendar_names(Option<Vec::<String>>):
    required: false
    

    The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

    
    
  • target_locations(TargetLocation) / set_target_locations(Option<Vec::<TargetLocation>>):
    required: false
    

    A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.

    
    
  • schedule_offset(i32) / set_schedule_offset(Option<i32>):
    required: false
    

    Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

    To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This option tells the system not to run an association immediately after you create it.

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: false
    

    The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

    The Duration parameter applies only when both these conditions are true:

    • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

    • The command specifies the ApplyOnlyAtCronInterval parameter, which means that the association doesn’t run immediately after it is updated, but only according to the specified schedule.

    
    
  • target_maps(HashMap::<String, Vec::<String>>) / set_target_maps(Option<Vec::<HashMap::<String, Vec::<String>>>>):
    required: false
    

    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can’t be specified together.

    
    
  • alarm_configuration(AlarmConfiguration) / set_alarm_configuration(Option<AlarmConfiguration>):
    required: false
    

    The details for the CloudWatch alarm you want to apply to an automation or command.

    
    
• On success, responds with UpdateAssociationOutput with field(s):
  • association_description(Option<AssociationDescription>):

    The description of the association that was updated.

• On failure, responds with SdkError<UpdateAssociationError>

impl Client

pub fn update_association_status(&self) -> UpdateAssociationStatusFluentBuilder

Constructs a fluent builder for the UpdateAssociationStatus operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the SSM document.

    
    
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The managed node ID.

    
    
  • association_status(AssociationStatus) / set_association_status(Option<AssociationStatus>):
    required: true
    

    The association status.

    
    
• On success, responds with UpdateAssociationStatusOutput with field(s):
  • association_description(Option<AssociationDescription>):

    Information about the association.

• On failure, responds with SdkError<UpdateAssociationStatusError>

impl Client

pub fn update_document(&self) -> UpdateDocumentFluentBuilder

Constructs a fluent builder for the UpdateDocument operation.

• The fluent builder is configurable:
  • content(impl Into<String>) / set_content(Option<String>):
    required: true
    

    A valid JSON or YAML string.

    
    
  • attachments(AttachmentsSource) / set_attachments(Option<Vec::<AttachmentsSource>>):
    required: false
    

    A list of key-value pairs that describe attachments to a version of a document.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the SSM document that you want to update.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don’t specify a value for this parameter in your request, the existing value is applied to the new document version.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can’t be changed.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

    If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

    
    
  • document_format(DocumentFormat) / set_document_format(Option<DocumentFormat>):
    required: false
    

    Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

    
    
  • target_type(impl Into<String>) / set_target_type(Option<String>):
    required: false
    

    Specify a new target type for the document.

    
    
• On success, responds with UpdateDocumentOutput with field(s):
  • document_description(Option<DocumentDescription>):

    A description of the document that was updated.

• On failure, responds with SdkError<UpdateDocumentError>

impl Client

pub fn update_document_default_version( &self, ) -> UpdateDocumentDefaultVersionFluentBuilder

Constructs a fluent builder for the UpdateDocumentDefaultVersion operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of a custom document that you want to set as the default version.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: true
    

    The version of a custom document that you want to set as the default version.

    
    
• On success, responds with UpdateDocumentDefaultVersionOutput with field(s):
  • description(Option<DocumentDefaultVersionDescription>):

    The description of a custom document that you want to set as the default version.

• On failure, responds with SdkError<UpdateDocumentDefaultVersionError>

impl Client

pub fn update_document_metadata(&self) -> UpdateDocumentMetadataFluentBuilder

Constructs a fluent builder for the UpdateDocumentMetadata operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the change template for which a version’s metadata is to be updated.

    
    
  • document_version(impl Into<String>) / set_document_version(Option<String>):
    required: false
    

    The version of a change template in which to update approval metadata.

    
    
  • document_reviews(DocumentReviews) / set_document_reviews(Option<DocumentReviews>):
    required: true
    

    The change template review details to update.

    
    
• On success, responds with UpdateDocumentMetadataOutput
• On failure, responds with SdkError<UpdateDocumentMetadataError>

impl Client

pub fn update_maintenance_window(&self) -> UpdateMaintenanceWindowFluentBuilder

Constructs a fluent builder for the UpdateMaintenanceWindow operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The ID of the maintenance window to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the maintenance window.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the update request.

    
    
  • start_date(impl Into<String>) / set_start_date(Option<String>):
    required: false
    

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

    When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.

    
    
  • end_date(impl Into<String>) / set_end_date(Option<String>):
    required: false
    

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

    
    
  • schedule(impl Into<String>) / set_schedule(Option<String>):
    required: false
    

    The schedule of the maintenance window in the form of a cron or rate expression.

    
    
  • schedule_timezone(impl Into<String>) / set_schedule_timezone(Option<String>):
    required: false
    

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”. For more information, see the Time Zone Database on the IANA website.

    
    
  • schedule_offset(i32) / set_schedule_offset(Option<i32>):
    required: false
    

    The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

    For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM.

    cron(30 23 ? * TUE#3 *)

    If the schedule offset is 2, the maintenance window won’t run until two days later.

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: false
    

    The duration of the maintenance window in hours.

    
    
  • cutoff(i32) / set_cutoff(Option<i32>):
    required: false
    

    The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

    
    
  • allow_unassociated_targets(bool) / set_allow_unassociated_targets(Option<bool>):
    required: false
    

    Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    Whether the maintenance window is enabled.

    
    
  • replace(bool) / set_replace(Option<bool>):
    required: false
    

    If True, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional fields that aren’t specified are set to null.

    
    
• On success, responds with UpdateMaintenanceWindowOutput with field(s):
  • window_id(Option<String>):

    The ID of the created maintenance window.

  • name(Option<String>):

    The name of the maintenance window.

  • description(Option<String>):

    An optional description of the update.

  • start_date(Option<String>):

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won’t run before this specified time.

  • end_date(Option<String>):

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won’t run after this specified time.

  • schedule(Option<String>):

    The schedule of the maintenance window in the form of a cron or rate expression.

  • schedule_timezone(Option<String>):

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”. For more information, see the Time Zone Database on the IANA website.

  • schedule_offset(Option<i32>):

    The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

  • duration(Option<i32>):

    The duration of the maintenance window in hours.

  • cutoff(i32):

    The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

  • allow_unassociated_targets(bool):

    Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

  • enabled(bool):

    Whether the maintenance window is enabled.

• On failure, responds with SdkError<UpdateMaintenanceWindowError>

impl Client

pub fn update_maintenance_window_target( &self, ) -> UpdateMaintenanceWindowTargetFluentBuilder

Constructs a fluent builder for the UpdateMaintenanceWindowTarget operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The maintenance window ID with which to modify the target.

    
    
  • window_target_id(impl Into<String>) / set_window_target_id(Option<String>):
    required: true
    

    The target ID to modify.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: false
    

    The targets to add or replace.

    
    
  • owner_information(impl Into<String>) / set_owner_information(Option<String>):
    required: false
    

    User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A name for the update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the update.

    
    
  • replace(bool) / set_replace(Option<bool>):
    required: false
    

    If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow operation are also required for this API request. Optional fields that aren’t specified are set to null.

    
    
• On success, responds with UpdateMaintenanceWindowTargetOutput with field(s):
  • window_id(Option<String>):

    The maintenance window ID specified in the update request.

  • window_target_id(Option<String>):

    The target ID specified in the update request.

  • targets(Option<Vec::<Target>>):

    The updated targets.

  • owner_information(Option<String>):

    The updated owner.

  • name(Option<String>):

    The updated name.

  • description(Option<String>):

    The updated description.

• On failure, responds with SdkError<UpdateMaintenanceWindowTargetError>

impl Client

pub fn update_maintenance_window_task( &self, ) -> UpdateMaintenanceWindowTaskFluentBuilder

Constructs a fluent builder for the UpdateMaintenanceWindowTask operation.

• The fluent builder is configurable:
  • window_id(impl Into<String>) / set_window_id(Option<String>):
    required: true
    

    The maintenance window ID that contains the task to modify.

    
    
  • window_task_id(impl Into<String>) / set_window_task_id(Option<String>):
    required: true
    

    The task ID to modify.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: false
    

    The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using the format Key=tag_name,Values=tag_value.

    One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

    
    
  • task_arn(impl Into<String>) / set_task_arn(Option<String>):
    required: false
    

    The task ARN to modify.

    
    
  • service_role_arn(impl Into<String>) / set_service_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

    
    
  • task_parameters(impl Into<String>, MaintenanceWindowTaskParameterValueExpression) / set_task_parameters(Option<HashMap::<String, MaintenanceWindowTaskParameterValueExpression>>):
    required: false
    

    The parameters to modify.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    The map has the following format:

    Key: string, between 1 and 255 characters

    Value: an array of strings, each string is between 1 and 255 characters

    
    
  • task_invocation_parameters(MaintenanceWindowTaskInvocationParameters) / set_task_invocation_parameters(Option<MaintenanceWindowTaskInvocationParameters>):
    required: false
    

    The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

    When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you don’t specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

    The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

    
    
  • max_concurrency(impl Into<String>) / set_max_concurrency(Option<String>):
    required: false
    

    The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task, in parallel.

    Although this element is listed as “Required: No”, a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

    For maintenance window tasks without a target specified, you can’t supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn’t affect the running of your task.

    
    
  • max_errors(impl Into<String>) / set_max_errors(Option<String>):
    required: false
    

    The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

    Although this element is listed as “Required: No”, a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

    For maintenance window tasks without a target specified, you can’t supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn’t affect the running of your task.

    
    
  • logging_info(LoggingInfo) / set_logging_info(Option<LoggingInfo>):
    required: false
    

    The new logging location in Amazon S3 to specify.

    LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The new task name to specify.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new task description to specify.

    
    
  • replace(bool) / set_replace(Option<bool>):
    required: false
    

    If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren’t specified are set to null.

    
    
  • cutoff_behavior(MaintenanceWindowTaskCutoffBehavior) / set_cutoff_behavior(Option<MaintenanceWindowTaskCutoffBehavior>):
    required: false
    

    Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

    • CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.

    • CANCEL_TASK:

      • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.

      • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

      The status for tasks that are not completed is TIMED_OUT.

    
    
  • alarm_configuration(AlarmConfiguration) / set_alarm_configuration(Option<AlarmConfiguration>):
    required: false
    

    The CloudWatch alarm you want to apply to your maintenance window task.

    
    
• On success, responds with UpdateMaintenanceWindowTaskOutput with field(s):
  • window_id(Option<String>):

    The ID of the maintenance window that was updated.

  • window_task_id(Option<String>):

    The task ID of the maintenance window that was updated.

  • targets(Option<Vec::<Target>>):

    The updated target values.

  • task_arn(Option<String>):

    The updated task ARN value.

  • service_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

    However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

  • task_parameters(Option<HashMap::<String, MaintenanceWindowTaskParameterValueExpression>>):

    The updated parameter values.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

  • task_invocation_parameters(Option<MaintenanceWindowTaskInvocationParameters>):

    The updated parameter values.

  • priority(i32):

    The updated priority value.

  • max_concurrency(Option<String>):

    The updated MaxConcurrency value.

  • max_errors(Option<String>):

    The updated MaxErrors value.

  • logging_info(Option<LoggingInfo>):

    The updated logging information in Amazon S3.

    LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

  • name(Option<String>):

    The updated task name.

  • description(Option<String>):

    The updated task description.

  • cutoff_behavior(Option<MaintenanceWindowTaskCutoffBehavior>):

    The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

  • alarm_configuration(Option<AlarmConfiguration>):

    The details for the CloudWatch alarm you applied to your maintenance window task.

• On failure, responds with SdkError<UpdateMaintenanceWindowTaskError>

impl Client

pub fn update_managed_instance_role( &self, ) -> UpdateManagedInstanceRoleFluentBuilder

Constructs a fluent builder for the UpdateManagedInstanceRole operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The ID of the managed node where you want to update the role.

    
    
  • iam_role(impl Into<String>) / set_iam_role(Option<String>):
    required: true
    

    The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create the IAM service role required for Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

    You can’t specify an IAM service-linked role for this parameter. You must create a unique role.

    
    
• On success, responds with UpdateManagedInstanceRoleOutput
• On failure, responds with SdkError<UpdateManagedInstanceRoleError>

impl Client

pub fn update_ops_item(&self) -> UpdateOpsItemFluentBuilder

Constructs a fluent builder for the UpdateOpsItem operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    User-defined text that contains information about the OpsItem, in Markdown format.

    
    
  • operational_data(impl Into<String>, OpsItemDataValue) / set_operational_data(Option<HashMap::<String, OpsItemDataValue>>):
    required: false
    

    Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

    Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

    Operational data keys can’t begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

    You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn’t searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

    Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

    
    
  • operational_data_to_delete(impl Into<String>) / set_operational_data_to_delete(Option<Vec::<String>>):
    required: false
    

    Keys that you want to remove from the OperationalData map.

    
    
  • notifications(OpsItemNotification) / set_notifications(Option<Vec::<OpsItemNotification>>):
    required: false
    

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

    The importance of this OpsItem in relation to other OpsItems in the system.

    
    
  • related_ops_items(RelatedOpsItem) / set_related_ops_items(Option<Vec::<RelatedOpsItem>>):
    required: false
    

    One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

    
    
  • status(OpsItemStatus) / set_status(Option<OpsItemStatus>):
    required: false
    

    The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

    
    
  • ops_item_id(impl Into<String>) / set_ops_item_id(Option<String>):
    required: true
    

    The ID of the OpsItem.

    
    
  • title(impl Into<String>) / set_title(Option<String>):
    required: false
    

    A short heading that describes the nature of the OpsItem and the impacted resource.

    
    
  • category(impl Into<String>) / set_category(Option<String>):
    required: false
    

    Specify a new category for an OpsItem.