Struct aws_sdk_ssm::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_ssm::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_ssm::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_ssm::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
Constructs a fluent builder for the AddTagsToResource
operation.
- The fluent builder is configurable:
resource_type(ResourceTypeForTagging)
/set_resource_type(Option<ResourceTypeForTagging>)
: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>)
: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 wordopsmetadata
in the ARN. For example, an OpsMetadata object with an ARN ofarn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has aResourceID
of eitheraws/ssm/MyGroup/appmanager
or/aws/ssm/MyGroup/appmanager
.For the
Document
andParameter
values, use the name of the resource.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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
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>)
: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>)
:The type of association that you want to create between an OpsItem and a resource. OpsCenter supports
IsParentOf
andRelatesTo
association types.resource_type(impl Into<String>)
/set_resource_type(Option<String>)
: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>)
: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>
sourcepub fn cancel_command(&self) -> CancelCommand
pub fn cancel_command(&self) -> CancelCommand
Constructs a fluent builder for the CancelCommand
operation.
- The fluent builder is configurable:
command_id(impl Into<String>)
/set_command_id(Option<String>)
:The ID of the command you want to cancel.
instance_ids(Vec<String>)
/set_instance_ids(Option<Vec<String>>)
:(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>
sourcepub fn cancel_maintenance_window_execution(
&self
) -> CancelMaintenanceWindowExecution
pub fn cancel_maintenance_window_execution(
&self
) -> CancelMaintenanceWindowExecution
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>)
: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>
sourcepub fn create_activation(&self) -> CreateActivation
pub fn create_activation(&self) -> CreateActivation
Constructs a fluent builder for the CreateActivation
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
: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>)
: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>)
: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 an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.registration_limit(i32)
/set_registration_limit(Option<i32>)
:Specify the maximum number of managed nodes you want to register. The default value is
1
.expiration_date(DateTime)
/set_expiration_date(Option<DateTime>)
:The date by which this activation request should expire, in timestamp format, such as “2021-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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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, seeRemoveTagsFromResource
.-
registration_metadata(Vec<RegistrationMetadataItem>)
/set_registration_metadata(Option<Vec<RegistrationMetadataItem>>)
: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>
sourcepub fn create_association(&self) -> CreateAssociation
pub fn create_association(&self) -> CreateAssociation
Constructs a fluent builder for the CreateAssociation
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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 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
orMy-Document
.document_version(impl Into<String>)
/set_document_version(Option<String>)
:The document version you want to associate with the target(s). 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 todefault
.instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use theTargets
parameter. Requests that include the parameterInstanceID
with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameterInstanceId
, you can’t use the parametersAssociationName
,DocumentVersion
,MaxErrors
,MaxConcurrency
,OutputLocation
, orScheduleExpression
. To use these parameters, you must use theTargets
parameter.parameters(HashMap<String, Vec<String>>)
/set_parameters(Option<HashMap<String, Vec<String>>>)
:The parameters for the runtime configuration of the document.
targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
: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 Using targets and rate controls with State Manager associations in the Amazon Web Services Systems Manager User Guide.schedule_expression(impl Into<String>)
/set_schedule_expression(Option<String>)
:A cron expression when the association will be applied to the target(s).
output_location(InstanceAssociationOutputLocation)
/set_output_location(Option<InstanceAssociationOutputLocation>)
: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>)
:Specify a descriptive name for the association.
automation_target_parameter_name(impl Into<String>)
/set_automation_target_parameter_name(Option<String>)
: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 capability of Amazon Web Services Systems Manager.
max_errors(impl Into<String>)
/set_max_errors(Option<String>)
: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, setMaxConcurrency
to 1 so that executions proceed one at a time.max_concurrency(impl Into<String>)
/set_max_concurrency(Option<String>)
: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 forMaxConcurrency
.compliance_severity(AssociationComplianceSeverity)
/set_compliance_severity(Option<AssociationComplianceSeverity>)
:The severity level to assign to the association.
sync_compliance(AssociationSyncCompliance)
/set_sync_compliance(Option<AssociationSyncCompliance>)
:The mode for generating association compliance. You can specify
AUTO
orMANUAL
. InAUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association isCOMPLIANT
. If the association execution doesn’t run successfully, the association isNON-COMPLIANT
.In
MANUAL
mode, you must specify theAssociationId
as a parameter for thePutComplianceItems
API operation. In this case, compliance data isn’t managed by State Manager. It is managed by your direct call to thePutComplianceItems
API operation.By default, all associations use
AUTO
mode.apply_only_at_cron_interval(bool)
/set_apply_only_at_cron_interval(bool)
: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(Vec<String>)
/set_calendar_names(Option<Vec<String>>)
: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(Vec<TargetLocation>)
/set_target_locations(Option<Vec<TargetLocation>>)
: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>)
: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.
- On success, responds with
CreateAssociationOutput
with field(s):association_description(Option<AssociationDescription>)
:Information about the association.
- On failure, responds with
SdkError<CreateAssociationError>
sourcepub fn create_association_batch(&self) -> CreateAssociationBatch
pub fn create_association_batch(&self) -> CreateAssociationBatch
Constructs a fluent builder for the CreateAssociationBatch
operation.
- The fluent builder is configurable:
entries(Vec<CreateAssociationBatchRequestEntry>)
/set_entries(Option<Vec<CreateAssociationBatchRequestEntry>>)
: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>
sourcepub fn create_document(&self) -> CreateDocument
pub fn create_document(&self) -> CreateDocument
Constructs a fluent builder for the CreateDocument
operation.
- The fluent builder is configurable:
content(impl Into<String>)
/set_content(Option<String>)
:The content for the new SSM document in JSON or YAML format. 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.
requires(Vec<DocumentRequires>)
/set_requires(Option<Vec<DocumentRequires>>)
: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 anApplicationConfigurationSchema
document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.attachments(Vec<AttachmentsSource>)
/set_attachments(Option<Vec<AttachmentsSource>>)
:A list of key-value pairs that describe attachments to a version of a document.
name(impl Into<String>)
/set_name(Option<String>)
: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
-
display_name(impl Into<String>)
/set_display_name(Option<String>)
: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>)
:An optional field specifying the version of the artifact you are creating with the document. For example, “Release 12, Update 6”. This value is unique across all versions of a document, and can’t be changed.
document_type(DocumentType)
/set_document_type(Option<DocumentType>)
: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>)
: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>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_maintenance_window(&self) -> CreateMaintenanceWindow
pub fn create_maintenance_window(&self) -> CreateMaintenanceWindow
Constructs a fluent builder for the CreateMaintenanceWindow
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the maintenance window.
description(impl Into<String>)
/set_description(Option<String>)
: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>)
: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.end_date(impl Into<String>)
/set_end_date(Option<String>)
: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>)
: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>)
: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>)
: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(i32)
:The duration of the maintenance window in hours.
cutoff(i32)
/set_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)
/set_allow_unassociated_targets(bool)
: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>)
:User-provided idempotency token.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_ops_item(&self) -> CreateOpsItem
pub fn create_ops_item(&self) -> CreateOpsItem
Constructs a fluent builder for the CreateOpsItem
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:Information about the OpsItem.
ops_item_type(impl Into<String>)
/set_ops_item_type(Option<String>)
:The type of OpsItem to create. Currently, the only valid values are
/aws/changerequest
and/aws/issue
.operational_data(HashMap<String, OpsItemDataValue>)
/set_operational_data(Option<HashMap<String, OpsItemDataValue>>)
: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 theGetOpsItem
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.notifications(Vec<OpsItemNotification>)
/set_notifications(Option<Vec<OpsItemNotification>>)
: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>)
:The importance of this OpsItem in relation to other OpsItems in the system.
related_ops_items(Vec<RelatedOpsItem>)
/set_related_ops_items(Option<Vec<RelatedOpsItem>>)
: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>)
:The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
The source name can’t contain the following strings:
aws
,amazon
, andamzn
.title(impl Into<String>)
/set_title(Option<String>)
:A short heading that describes the nature of the OpsItem and the impacted resource.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
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 thessm:AddTagsToResource
operation. To add tags to an existing OpsItem, use theAddTagsToResource
operation.category(impl Into<String>)
/set_category(Option<String>)
:Specify a category to assign to an OpsItem.
severity(impl Into<String>)
/set_severity(Option<String>)
:Specify a severity to assign to an OpsItem.
actual_start_time(DateTime)
/set_actual_start_time(Option<DateTime>)
: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>)
: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>)
: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>)
:The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type
/aws/changerequest
.
- On success, responds with
CreateOpsItemOutput
with field(s):ops_item_id(Option<String>)
:The ID of the OpsItem.
- On failure, responds with
SdkError<CreateOpsItemError>
sourcepub fn create_ops_metadata(&self) -> CreateOpsMetadata
pub fn create_ops_metadata(&self) -> CreateOpsMetadata
Constructs a fluent builder for the CreateOpsMetadata
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:A resource ID for a new Application Manager application.
metadata(HashMap<String, MetadataValue>)
/set_metadata(Option<HashMap<String, MetadataValue>>)
:Metadata for a new Application Manager application.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_patch_baseline(&self) -> CreatePatchBaseline
pub fn create_patch_baseline(&self) -> CreatePatchBaseline
Constructs a fluent builder for the CreatePatchBaseline
operation.
- The fluent builder is configurable:
operating_system(OperatingSystem)
/set_operating_system(Option<OperatingSystem>)
:Defines the operating system the patch baseline applies to. The default value is
WINDOWS
.name(impl Into<String>)
/set_name(Option<String>)
:The name of the patch baseline.
global_filters(PatchFilterGroup)
/set_global_filters(Option<PatchFilterGroup>)
:A set of global filters used to include patches in the baseline.
approval_rules(PatchRuleGroup)
/set_approval_rules(Option<PatchRuleGroup>)
:A set of rules used to include patches in the baseline.
approved_patches(Vec<String>)
/set_approved_patches(Option<Vec<String>>)
:A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About 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>)
: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>)
: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(Vec<String>)
/set_rejected_patches(Option<Vec<String>>)
:A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About 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>)
:The action for Patch Manager to take on patches included in the
RejectedPackages
list.-
ALLOW_AS_DEPENDENCY
: A package in theRejected
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 asInstalledOther
. This is the default action if no option is specified. -
BLOCK
: Packages in theRejectedPatches
list, and packages that include them as dependencies, aren’t installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported asInstalledRejected
.
-
description(impl Into<String>)
/set_description(Option<String>)
:A description of the patch baseline.
sources(Vec<PatchSource>)
/set_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.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:User-provided idempotency token.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_resource_data_sync(&self) -> CreateResourceDataSync
pub fn create_resource_data_sync(&self) -> CreateResourceDataSync
Constructs a fluent builder for the CreateResourceDataSync
operation.
- The fluent builder is configurable:
sync_name(impl Into<String>)
/set_sync_name(Option<String>)
:A name for the configuration.
s3_destination(ResourceDataSyncS3Destination)
/set_s3_destination(Option<ResourceDataSyncS3Destination>)
: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>)
:Specify
SyncToDestination
to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specifySyncToDestination
, you must provide a value forS3Destination
. SpecifySyncFromSource
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 specifySyncFromSource
, you must provide a value forSyncSource
. The default value isSyncToDestination
.sync_source(ResourceDataSyncSource)
/set_sync_source(Option<ResourceDataSyncSource>)
: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>
sourcepub fn delete_activation(&self) -> DeleteActivation
pub fn delete_activation(&self) -> DeleteActivation
Constructs a fluent builder for the DeleteActivation
operation.
- The fluent builder is configurable:
activation_id(impl Into<String>)
/set_activation_id(Option<String>)
:The ID of the activation that you want to delete.
- On success, responds with
DeleteActivationOutput
- On failure, responds with
SdkError<DeleteActivationError>
sourcepub fn delete_association(&self) -> DeleteAssociation
pub fn delete_association(&self) -> DeleteAssociation
Constructs a fluent builder for the DeleteAssociation
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the SSM document.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The managed node ID.
InstanceId
has been deprecated. To specify a managed node ID for an association, use theTargets
parameter. Requests that include the parameterInstanceID
with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameterInstanceId
, you can’t use the parametersAssociationName
,DocumentVersion
,MaxErrors
,MaxConcurrency
,OutputLocation
, orScheduleExpression
. To use these parameters, you must use theTargets
parameter.association_id(impl Into<String>)
/set_association_id(Option<String>)
:The association ID that you want to delete.
- On success, responds with
DeleteAssociationOutput
- On failure, responds with
SdkError<DeleteAssociationError>
sourcepub fn delete_document(&self) -> DeleteDocument
pub fn delete_document(&self) -> DeleteDocument
Constructs a fluent builder for the DeleteDocument
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the document.
document_version(impl Into<String>)
/set_document_version(Option<String>)
: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>)
: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(bool)
:Some SSM document types require that you specify a
Force
flag before you can delete the document. For example, you must specify aForce
flag to delete a document of typeApplicationConfigurationSchema
. You can restrict access to theForce
flag in an Identity and Access Management (IAM) policy.
- On success, responds with
DeleteDocumentOutput
- On failure, responds with
SdkError<DeleteDocumentError>
sourcepub fn delete_inventory(&self) -> DeleteInventory
pub fn delete_inventory(&self) -> DeleteInventory
Constructs a fluent builder for the DeleteInventory
operation.
- The fluent builder is configurable:
type_name(impl Into<String>)
/set_type_name(Option<String>)
: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>)
: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(bool)
: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>)
: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>
sourcepub fn delete_maintenance_window(&self) -> DeleteMaintenanceWindow
pub fn delete_maintenance_window(&self) -> DeleteMaintenanceWindow
Constructs a fluent builder for the DeleteMaintenanceWindow
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
: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>
sourcepub fn delete_ops_metadata(&self) -> DeleteOpsMetadata
pub fn delete_ops_metadata(&self) -> DeleteOpsMetadata
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>)
:The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.
- On success, responds with
DeleteOpsMetadataOutput
- On failure, responds with
SdkError<DeleteOpsMetadataError>
sourcepub fn delete_parameter(&self) -> DeleteParameter
pub fn delete_parameter(&self) -> DeleteParameter
Constructs a fluent builder for the DeleteParameter
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the parameter to delete.
- On success, responds with
DeleteParameterOutput
- On failure, responds with
SdkError<DeleteParameterError>
sourcepub fn delete_parameters(&self) -> DeleteParameters
pub fn delete_parameters(&self) -> DeleteParameters
Constructs a fluent builder for the DeleteParameters
operation.
- The fluent builder is configurable:
names(Vec<String>)
/set_names(Option<Vec<String>>)
: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.
- 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>
sourcepub fn delete_patch_baseline(&self) -> DeletePatchBaseline
pub fn delete_patch_baseline(&self) -> DeletePatchBaseline
Constructs a fluent builder for the DeletePatchBaseline
operation.
- The fluent builder is configurable:
baseline_id(impl Into<String>)
/set_baseline_id(Option<String>)
: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>
sourcepub fn delete_resource_data_sync(&self) -> DeleteResourceDataSync
pub fn delete_resource_data_sync(&self) -> DeleteResourceDataSync
Constructs a fluent builder for the DeleteResourceDataSync
operation.
- The fluent builder is configurable:
sync_name(impl Into<String>)
/set_sync_name(Option<String>)
:The name of the configuration to delete.
sync_type(impl Into<String>)
/set_sync_type(Option<String>)
:Specify the type of resource data sync to delete.
- On success, responds with
DeleteResourceDataSyncOutput
- On failure, responds with
SdkError<DeleteResourceDataSyncError>
sourcepub fn deregister_managed_instance(&self) -> DeregisterManagedInstance
pub fn deregister_managed_instance(&self) -> DeregisterManagedInstance
Constructs a fluent builder for the DeregisterManagedInstance
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
: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>
sourcepub fn deregister_patch_baseline_for_patch_group(
&self
) -> DeregisterPatchBaselineForPatchGroup
pub fn deregister_patch_baseline_for_patch_group(
&self
) -> DeregisterPatchBaselineForPatchGroup
Constructs a fluent builder for the DeregisterPatchBaselineForPatchGroup
operation.
- The fluent builder is configurable:
baseline_id(impl Into<String>)
/set_baseline_id(Option<String>)
:The ID of the patch baseline to deregister the patch group from.
patch_group(impl Into<String>)
/set_patch_group(Option<String>)
: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>
sourcepub fn deregister_target_from_maintenance_window(
&self
) -> DeregisterTargetFromMaintenanceWindow
pub fn deregister_target_from_maintenance_window(
&self
) -> DeregisterTargetFromMaintenanceWindow
Constructs a fluent builder for the DeregisterTargetFromMaintenanceWindow
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
:The ID of the maintenance window the target should be removed from.
window_target_id(impl Into<String>)
/set_window_target_id(Option<String>)
:The ID of the target definition to remove.
safe(bool)
/set_safe(Option<bool>)
: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>
sourcepub fn deregister_task_from_maintenance_window(
&self
) -> DeregisterTaskFromMaintenanceWindow
pub fn deregister_task_from_maintenance_window(
&self
) -> DeregisterTaskFromMaintenanceWindow
Constructs a fluent builder for the DeregisterTaskFromMaintenanceWindow
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
:The ID of the maintenance window the task should be removed from.
window_task_id(impl Into<String>)
/set_window_task_id(Option<String>)
: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>
sourcepub fn describe_activations(&self) -> DescribeActivations
pub fn describe_activations(&self) -> DescribeActivations
Constructs a fluent builder for the DescribeActivations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<DescribeActivationsFilter>)
/set_filters(Option<Vec<DescribeActivationsFilter>>)
:A filter to view information about your activations.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_association(&self) -> DescribeAssociation
pub fn describe_association(&self) -> DescribeAssociation
Constructs a fluent builder for the DescribeAssociation
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the SSM document.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The managed node ID.
association_id(impl Into<String>)
/set_association_id(Option<String>)
:The association ID for which you want information.
association_version(impl Into<String>)
/set_association_version(Option<String>)
: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, useListAssociations
. To get a list of versions for a specific association, useListAssociationVersions
.
- On success, responds with
DescribeAssociationOutput
with field(s):association_description(Option<AssociationDescription>)
:Information about the association.
- On failure, responds with
SdkError<DescribeAssociationError>
sourcepub fn describe_association_executions(&self) -> DescribeAssociationExecutions
pub fn describe_association_executions(&self) -> DescribeAssociationExecutions
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>)
:The association ID for which you want to view execution history details.
filters(Vec<AssociationExecutionFilter>)
/set_filters(Option<Vec<AssociationExecutionFilter>>)
: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>)
: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>)
: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>
sourcepub fn describe_association_execution_targets(
&self
) -> DescribeAssociationExecutionTargets
pub fn describe_association_execution_targets(
&self
) -> DescribeAssociationExecutionTargets
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>)
:The association ID that includes the execution for which you want to view details.
execution_id(impl Into<String>)
/set_execution_id(Option<String>)
:The execution ID for which you want to view details.
filters(Vec<AssociationExecutionTargetsFilter>)
/set_filters(Option<Vec<AssociationExecutionTargetsFilter>>)
: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>)
: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>)
: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>
sourcepub fn describe_automation_executions(&self) -> DescribeAutomationExecutions
pub fn describe_automation_executions(&self) -> DescribeAutomationExecutions
Constructs a fluent builder for the DescribeAutomationExecutions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<AutomationExecutionFilter>)
/set_filters(Option<Vec<AutomationExecutionFilter>>)
:Filters used to limit the scope of executions that are requested.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_automation_step_executions(
&self
) -> DescribeAutomationStepExecutions
pub fn describe_automation_step_executions(
&self
) -> DescribeAutomationStepExecutions
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>)
:The Automation execution ID for which you want step execution descriptions.
filters(Vec<StepExecutionFilter>)
/set_filters(Option<Vec<StepExecutionFilter>>)
: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>)
: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>)
: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>)
: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>
sourcepub fn describe_available_patches(&self) -> DescribeAvailablePatches
pub fn describe_available_patches(&self) -> DescribeAvailablePatches
Constructs a fluent builder for the DescribeAvailablePatches
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<PatchOrchestratorFilter>)
/set_filters(Option<Vec<PatchOrchestratorFilter>>)
: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>)
:The maximum number of patches to return (per page).
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn describe_document(&self) -> DescribeDocument
pub fn describe_document(&self) -> DescribeDocument
Constructs a fluent builder for the DescribeDocument
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the SSM document.
document_version(impl Into<String>)
/set_document_version(Option<String>)
: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>)
:An optional field specifying the version of the artifact associated with the document. For example, “Release 12, Update 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>
sourcepub fn describe_document_permission(&self) -> DescribeDocumentPermission
pub fn describe_document_permission(&self) -> DescribeDocumentPermission
Constructs a fluent builder for the DescribeDocumentPermission
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the document for which you are the owner.
permission_type(DocumentPermissionType)
/set_permission_type(Option<DocumentPermissionType>)
:The permission type for the document. The permission type can be Share.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_effective_instance_associations(
&self
) -> DescribeEffectiveInstanceAssociations
pub fn describe_effective_instance_associations(
&self
) -> DescribeEffectiveInstanceAssociations
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>)
:The managed node ID for which you want to view all associations.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_effective_patches_for_patch_baseline(
&self
) -> DescribeEffectivePatchesForPatchBaseline
pub fn describe_effective_patches_for_patch_baseline(
&self
) -> DescribeEffectivePatchesForPatchBaseline
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>)
:The ID of the patch baseline to retrieve the effective patches for.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of patches to return (per page).
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn describe_instance_associations_status(
&self
) -> DescribeInstanceAssociationsStatus
pub fn describe_instance_associations_status(
&self
) -> DescribeInstanceAssociationsStatus
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>)
:The managed node IDs for which you want association status information.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_instance_information(&self) -> DescribeInstanceInformation
pub fn describe_instance_information(&self) -> DescribeInstanceInformation
Constructs a fluent builder for the DescribeInstanceInformation
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
instance_information_filter_list(Vec<InstanceInformationFilter>)
/set_instance_information_filter_list(Option<Vec<InstanceInformationFilter>>)
: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
andFilters
leads to an exception error.filters(Vec<InstanceInformationStringFilter>)
/set_filters(Option<Vec<InstanceInformationStringFilter>>)
:One or more filters. Use a filter to return a more specific list of managed nodes. You can filter based on tags applied to EC2 instances. Use this
Filters
data type instead ofInstanceInformationFilterList
, which is deprecated.max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_instance_patches(&self) -> DescribeInstancePatches
pub fn describe_instance_patches(&self) -> DescribeInstancePatches
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>)
:The ID of the managed node whose patch state information should be retrieved.
filters(Vec<PatchOrchestratorFilter>)
/set_filters(Option<Vec<PatchOrchestratorFilter>>)
:Each element in the array is a structure containing a key-value pair.
Supported keys for
DescribeInstancePatches
include 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
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
: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>
sourcepub fn describe_instance_patch_states(&self) -> DescribeInstancePatchStates
pub fn describe_instance_patch_states(&self) -> DescribeInstancePatchStates
Constructs a fluent builder for the DescribeInstancePatchStates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
instance_ids(Vec<String>)
/set_instance_ids(Option<Vec<String>>)
:The ID of the managed node for which patch state information should be retrieved.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
: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>
sourcepub fn describe_instance_patch_states_for_patch_group(
&self
) -> DescribeInstancePatchStatesForPatchGroup
pub fn describe_instance_patch_states_for_patch_group(
&self
) -> DescribeInstancePatchStatesForPatchGroup
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>)
:The name of the patch group for which the patch state information should be retrieved.
filters(Vec<InstancePatchStateFilter>)
/set_filters(Option<Vec<InstancePatchStateFilter>>)
: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>)
: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>)
: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>
sourcepub fn describe_inventory_deletions(&self) -> DescribeInventoryDeletions
pub fn describe_inventory_deletions(&self) -> DescribeInventoryDeletions
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>)
: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>)
:A token to start the list. Use this token to get the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn describe_maintenance_window_executions(
&self
) -> DescribeMaintenanceWindowExecutions
pub fn describe_maintenance_window_executions(
&self
) -> DescribeMaintenanceWindowExecutions
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>)
:The ID of the maintenance window whose executions should be retrieved.
filters(Vec<MaintenanceWindowFilter>)
/set_filters(Option<Vec<MaintenanceWindowFilter>>)
:Each entry in the array is a structure containing:
-
Key. A string between 1 and 128 characters. Supported keys include
ExecutedBefore
andExecutedAfter
. -
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
2021-11-04T05:00:00Z
.
-
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_maintenance_window_execution_task_invocations(
&self
) -> DescribeMaintenanceWindowExecutionTaskInvocations
pub fn describe_maintenance_window_execution_task_invocations(
&self
) -> DescribeMaintenanceWindowExecutionTaskInvocations
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>)
:The ID of the maintenance window execution the task is part of.
task_id(impl Into<String>)
/set_task_id(Option<String>)
:The ID of the specific task in the maintenance window task that should be retrieved.
filters(Vec<MaintenanceWindowFilter>)
/set_filters(Option<Vec<MaintenanceWindowFilter>>)
:Optional filters used to scope down the returned task invocations. The supported filter key is
STATUS
with the corresponding valuesPENDING
,IN_PROGRESS
,SUCCESS
,FAILED
,TIMED_OUT
,CANCELLING
, andCANCELLED
.max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_maintenance_window_execution_tasks(
&self
) -> DescribeMaintenanceWindowExecutionTasks
pub fn describe_maintenance_window_execution_tasks(
&self
) -> DescribeMaintenanceWindowExecutionTasks
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>)
:The ID of the maintenance window execution whose task executions should be retrieved.
filters(Vec<MaintenanceWindowFilter>)
/set_filters(Option<Vec<MaintenanceWindowFilter>>)
:Optional filters used to scope down the returned tasks. The supported filter key is
STATUS
with the corresponding valuesPENDING
,IN_PROGRESS
,SUCCESS
,FAILED
,TIMED_OUT
,CANCELLING
, andCANCELLED
.max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_maintenance_windows(&self) -> DescribeMaintenanceWindows
pub fn describe_maintenance_windows(&self) -> DescribeMaintenanceWindows
Constructs a fluent builder for the DescribeMaintenanceWindows
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<MaintenanceWindowFilter>)
/set_filters(Option<Vec<MaintenanceWindowFilter>>)
:Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are
Name
andEnabled
. For example,Name=MyMaintenanceWindow
andEnabled=True
.max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_maintenance_window_schedule(
&self
) -> DescribeMaintenanceWindowSchedule
pub fn describe_maintenance_window_schedule(
&self
) -> DescribeMaintenanceWindowSchedule
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>)
:The ID of the maintenance window to retrieve information about.
targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
:The managed node ID or key-value pair to retrieve information about.
resource_type(MaintenanceWindowResourceType)
/set_resource_type(Option<MaintenanceWindowResourceType>)
:The type of resource you want to retrieve information about. For example,
INSTANCE
.filters(Vec<PatchOrchestratorFilter>)
/set_filters(Option<Vec<PatchOrchestratorFilter>>)
: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>)
: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>)
: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>
sourcepub fn describe_maintenance_windows_for_target(
&self
) -> DescribeMaintenanceWindowsForTarget
pub fn describe_maintenance_windows_for_target(
&self
) -> DescribeMaintenanceWindowsForTarget
Constructs a fluent builder for the DescribeMaintenanceWindowsForTarget
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
:The managed node ID or key-value pair to retrieve information about.
resource_type(MaintenanceWindowResourceType)
/set_resource_type(Option<MaintenanceWindowResourceType>)
:The type of resource you want to retrieve information about. For example,
INSTANCE
.max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_maintenance_window_targets(
&self
) -> DescribeMaintenanceWindowTargets
pub fn describe_maintenance_window_targets(
&self
) -> DescribeMaintenanceWindowTargets
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>)
:The ID of the maintenance window whose targets should be retrieved.
filters(Vec<MaintenanceWindowFilter>)
/set_filters(Option<Vec<MaintenanceWindowFilter>>)
:Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are
Type
,WindowTargetId
, andOwnerInformation
.max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_maintenance_window_tasks(
&self
) -> DescribeMaintenanceWindowTasks
pub fn describe_maintenance_window_tasks(
&self
) -> DescribeMaintenanceWindowTasks
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>)
:The ID of the maintenance window whose tasks should be retrieved.
filters(Vec<MaintenanceWindowFilter>)
/set_filters(Option<Vec<MaintenanceWindowFilter>>)
:Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are
WindowTaskId
,TaskArn
,Priority
, andTaskType
.max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn describe_ops_items(&self) -> DescribeOpsItems
pub fn describe_ops_items(&self) -> DescribeOpsItems
Constructs a fluent builder for the DescribeOpsItems
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
ops_item_filters(Vec<OpsItemFilter>)
/set_ops_item_filters(Option<Vec<OpsItemFilter>>)
: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
*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>)
: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>)
: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>
sourcepub fn describe_parameters(&self) -> DescribeParameters
pub fn describe_parameters(&self) -> DescribeParameters
Constructs a fluent builder for the DescribeParameters
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<ParametersFilter>)
/set_filters(Option<Vec<ParametersFilter>>)
:This data type is deprecated. Instead, use
ParameterFilters
.parameter_filters(Vec<ParameterStringFilter>)
/set_parameter_filters(Option<Vec<ParameterStringFilter>>)
:Filters to limit the request results.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
:The token for the next set of items to return. (You received this token from a previous call.)
- 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>
sourcepub fn describe_patch_baselines(&self) -> DescribePatchBaselines
pub fn describe_patch_baselines(&self) -> DescribePatchBaselines
Constructs a fluent builder for the DescribePatchBaselines
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<PatchOrchestratorFilter>)
/set_filters(Option<Vec<PatchOrchestratorFilter>>)
: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>)
:The maximum number of patch baselines to return (per page).
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn describe_patch_groups(&self) -> DescribePatchGroups
pub fn describe_patch_groups(&self) -> DescribePatchGroups
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>)
:The maximum number of patch groups to return (per page).
filters(Vec<PatchOrchestratorFilter>)
/set_filters(Option<Vec<PatchOrchestratorFilter>>)
: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>)
: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
: APatchBaselineIdentity
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>
sourcepub fn describe_patch_group_state(&self) -> DescribePatchGroupState
pub fn describe_patch_group_state(&self) -> DescribePatchGroupState
Constructs a fluent builder for the DescribePatchGroupState
operation.
- The fluent builder is configurable:
patch_group(impl Into<String>)
/set_patch_group(Option<String>)
: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 ofINSTALLED_REJECTED
were typically installed before they were added to aRejectedPatches
list.If
ALLOW_AS_DEPENDENCY
is the specified option forRejectedPatchesAction
, the value ofInstancesWithInstalledRejectedPatches
will always be0
(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 capability of 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 isNON_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 isNON_COMPLIANT
.instances_with_other_non_compliant_patches(Option<i32>)
:The number of managed nodes with patches installed that are specified as other than
Critical
orSecurity
but aren’t compliant with the patch baseline. The status of these managed nodes isNON_COMPLIANT
.
- On failure, responds with
SdkError<DescribePatchGroupStateError>
sourcepub fn describe_patch_properties(&self) -> DescribePatchProperties
pub fn describe_patch_properties(&self) -> DescribePatchProperties
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>)
:The operating system type for which to list patches.
property(PatchProperty)
/set_property(Option<PatchProperty>)
:The patch property for which you want to view patch details.
patch_set(PatchSet)
/set_patch_set(Option<PatchSet>)
: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>)
: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>)
: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>
sourcepub fn describe_sessions(&self) -> DescribeSessions
pub fn describe_sessions(&self) -> DescribeSessions
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>)
:The session status to retrieve a list of sessions for. For example, “Active”.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
:The token for the next set of items to return. (You received this token from a previous call.)
filters(Vec<SessionFilter>)
/set_filters(Option<Vec<SessionFilter>>)
: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>
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>)
: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>)
: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>
sourcepub fn get_automation_execution(&self) -> GetAutomationExecution
pub fn get_automation_execution(&self) -> GetAutomationExecution
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>)
: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>
sourcepub fn get_calendar_state(&self) -> GetCalendarState
pub fn get_calendar_state(&self) -> GetCalendarState
Constructs a fluent builder for the GetCalendarState
operation.
- The fluent builder is configurable:
calendar_names(Vec<String>)
/set_calendar_names(Option<Vec<String>>)
: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>)
:(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 aCLOSED
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 toCLOSED
, and vice-versa.
- On failure, responds with
SdkError<GetCalendarStateError>
sourcepub fn get_command_invocation(&self) -> GetCommandInvocation
pub fn get_command_invocation(&self) -> GetCommandInvocation
Constructs a fluent builder for the GetCommandInvocation
operation.
- The fluent builder is configurable:
command_id(impl Into<String>)
/set_command_id(Option<String>)
:(Required) The parent command ID of the invocation plugin.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:(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>)
:The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.
Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example,
aws:RunShellScript
is a plugin.To find the
PluginName
, check the document content and find the name of the plugin. Alternatively, useListCommandInvocations
with theCommandId
andDetails
parameters. ThePluginName
is theName
attribute of theCommandPlugin
object in theCommandPlugins
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 thanStatus
because it includes states resulting from error and concurrency control parameters.StatusDetails
can show different results thanStatus
. 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, ifExecutionStatus
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>
sourcepub fn get_connection_status(&self) -> GetConnectionStatus
pub fn get_connection_status(&self) -> GetConnectionStatus
Constructs a fluent builder for the GetConnectionStatus
operation.
- The fluent builder is configurable:
target(impl Into<String>)
/set_target(Option<String>)
: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. For example, ‘Connected’ or ‘Not Connected’.
- On failure, responds with
SdkError<GetConnectionStatusError>
sourcepub fn get_default_patch_baseline(&self) -> GetDefaultPatchBaseline
pub fn get_default_patch_baseline(&self) -> GetDefaultPatchBaseline
Constructs a fluent builder for the GetDefaultPatchBaseline
operation.
- The fluent builder is configurable:
operating_system(OperatingSystem)
/set_operating_system(Option<OperatingSystem>)
: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>
sourcepub fn get_deployable_patch_snapshot_for_instance(
&self
) -> GetDeployablePatchSnapshotForInstance
pub fn get_deployable_patch_snapshot_for_instance(
&self
) -> GetDeployablePatchSnapshotForInstance
Constructs a fluent builder for the GetDeployablePatchSnapshotForInstance
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
: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>)
:The snapshot ID provided by the user when running
AWS-RunPatchBaseline
.baseline_override(BaselineOverride)
/set_baseline_override(Option<BaselineOverride>)
: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>
sourcepub fn get_document(&self) -> GetDocument
pub fn get_document(&self) -> GetDocument
Constructs a fluent builder for the GetDocument
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the SSM document.
version_name(impl Into<String>)
/set_version_name(Option<String>)
:An optional field specifying the version of the artifact associated with the document. For example, “Release 12, Update 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>)
:The document version for which you want information.
document_format(DocumentFormat)
/set_document_format(Option<DocumentFormat>)
: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, “Release 12, Update 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
, andDeleting
.status_information(Option<String>)
:A message returned by Amazon Web Services Systems Manager that explains the
Status
value. For example, aFailed
status might be explained by theStatusInformation
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 anApplicationConfigurationSchema
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>
sourcepub fn get_inventory(&self) -> GetInventory
pub fn get_inventory(&self) -> GetInventory
Constructs a fluent builder for the GetInventory
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<InventoryFilter>)
/set_filters(Option<Vec<InventoryFilter>>)
:One or more filters. Use a filter to return a more specific list of results.
aggregators(Vec<InventoryAggregator>)
/set_aggregators(Option<Vec<InventoryAggregator>>)
: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(Vec<ResultAttribute>)
/set_result_attributes(Option<Vec<ResultAttribute>>)
:The list of inventory item types to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
: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>
sourcepub fn get_inventory_schema(&self) -> GetInventorySchema
pub fn get_inventory_schema(&self) -> GetInventorySchema
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>)
:The type of inventory item to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
: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(bool)
:Returns inventory schemas that support aggregation. For example, this call returns the
AWS:InstanceInformation
type, because it supports aggregation based on thePlatformName
,PlatformType
, andPlatformVersion
attributes.sub_type(bool)
/set_sub_type(Option<bool>)
: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>
sourcepub fn get_maintenance_window(&self) -> GetMaintenanceWindow
pub fn get_maintenance_window(&self) -> GetMaintenanceWindow
Constructs a fluent builder for the GetMaintenanceWindow
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
: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(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>
sourcepub fn get_maintenance_window_execution(&self) -> GetMaintenanceWindowExecution
pub fn get_maintenance_window_execution(&self) -> GetMaintenanceWindowExecution
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>)
: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>
sourcepub fn get_maintenance_window_execution_task(
&self
) -> GetMaintenanceWindowExecutionTask
pub fn get_maintenance_window_execution_task(
&self
) -> GetMaintenanceWindowExecutionTask
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>)
:The ID of the maintenance window execution that includes the task.
task_id(impl Into<String>)
/set_task_id(Option<String>)
: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 theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, seeMaintenanceWindowTaskInvocationParameters
.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.
- On failure, responds with
SdkError<GetMaintenanceWindowExecutionTaskError>
sourcepub fn get_maintenance_window_execution_task_invocation(
&self
) -> GetMaintenanceWindowExecutionTaskInvocation
pub fn get_maintenance_window_execution_task_invocation(
&self
) -> GetMaintenanceWindowExecutionTaskInvocation
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>)
:The ID of the maintenance window execution for which the task is a part.
task_id(impl Into<String>)
/set_task_id(Option<String>)
: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>)
: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>
sourcepub fn get_maintenance_window_task(&self) -> GetMaintenanceWindowTask
pub fn get_maintenance_window_task(&self) -> GetMaintenanceWindowTask
Constructs a fluent builder for the GetMaintenanceWindowTask
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
:The maintenance window ID that includes the task to retrieve.
window_task_id(impl Into<String>)
/set_window_task_id(Option<String>)
: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
andAUTOMATION
task types, the value ofTaskArn
is the SSM document name/ARN. ForLAMBDA
tasks, the value is the function name/ARN. ForSTEP_FUNCTIONS
tasks, the value is the state machine ARN.service_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
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 theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, seeMaintenanceWindowTaskInvocationParameters
.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 theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, seeMaintenanceWindowTaskInvocationParameters
.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 aCancelCommand
operation.
- On failure, responds with
SdkError<GetMaintenanceWindowTaskError>
sourcepub fn get_ops_item(&self) -> GetOpsItem
pub fn get_ops_item(&self) -> GetOpsItem
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>)
:The ID of the OpsItem that you want to get.
- On success, responds with
GetOpsItemOutput
with field(s):ops_item(Option<OpsItem>)
:The OpsItem.
- On failure, responds with
SdkError<GetOpsItemError>
sourcepub fn get_ops_metadata(&self) -> GetOpsMetadata
pub fn get_ops_metadata(&self) -> GetOpsMetadata
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>)
:The Amazon Resource Name (ARN) of an OpsMetadata Object to view.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn get_ops_summary(&self) -> GetOpsSummary
pub fn get_ops_summary(&self) -> GetOpsSummary
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>)
:Specify the name of a resource data sync to get.
filters(Vec<OpsFilter>)
/set_filters(Option<Vec<OpsFilter>>)
:Optional filters used to scope down the returned OpsData.
aggregators(Vec<OpsAggregator>)
/set_aggregators(Option<Vec<OpsAggregator>>)
:Optional aggregators that return counts of OpsData based on one or more expressions.
result_attributes(Vec<OpsResultAttribute>)
/set_result_attributes(Option<Vec<OpsResultAttribute>>)
:The OpsData data type to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token to start the list. Use this token to get the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn get_parameter(&self) -> GetParameter
pub fn get_parameter(&self) -> GetParameter
Constructs a fluent builder for the GetParameter
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the parameter you want to query.
To query by parameter label, use
“Name”: “name:label”
. To query by parameter version, use“Name”: “name:version”
.with_decryption(bool)
/set_with_decryption(Option<bool>)
:Return decrypted values for secure string parameters. This flag is ignored for
String
andStringList
parameter types.
- On success, responds with
GetParameterOutput
with field(s):parameter(Option<Parameter>)
:Information about a parameter.
- On failure, responds with
SdkError<GetParameterError>
sourcepub fn get_parameter_history(&self) -> GetParameterHistory
pub fn get_parameter_history(&self) -> GetParameterHistory
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>)
:The name of the parameter for which you want to review history.
with_decryption(bool)
/set_with_decryption(Option<bool>)
:Return decrypted values for secure string parameters. This flag is ignored for
String
andStringList
parameter types.max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn get_parameters(&self) -> GetParameters
pub fn get_parameters(&self) -> GetParameters
Constructs a fluent builder for the GetParameters
operation.
- The fluent builder is configurable:
names(Vec<String>)
/set_names(Option<Vec<String>>)
:Names of the parameters for which you want to query information.
To query by parameter label, use
“Name”: “name:label”
. To query by parameter version, use“Name”: “name:version”
.with_decryption(bool)
/set_with_decryption(Option<bool>)
:Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for
String
andStringList
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>
sourcepub fn get_parameters_by_path(&self) -> GetParametersByPath
pub fn get_parameters_by_path(&self) -> GetParametersByPath
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>)
: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>)
: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(Vec<ParameterStringFilter>)
/set_parameter_filters(Option<Vec<ParameterStringFilter>>)
:Filters to limit the request results.
The following
Key
values are supported forGetParametersByPath
:Type
,KeyId
, andLabel
.The following
Key
values aren’t supported forGetParametersByPath
:tag
,DataType
,Name
,Path
, andTier
.with_decryption(bool)
/set_with_decryption(Option<bool>)
:Retrieve all parameters in a hierarchy with their value decrypted.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn get_patch_baseline(&self) -> GetPatchBaseline
pub fn get_patch_baseline(&self) -> GetPatchBaseline
Constructs a fluent builder for the GetPatchBaseline
operation.
- The fluent builder is configurable:
baseline_id(impl Into<String>)
/set_baseline_id(Option<String>)
: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
, specifyarn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7
instead ofpb-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>
sourcepub fn get_patch_baseline_for_patch_group(
&self
) -> GetPatchBaselineForPatchGroup
pub fn get_patch_baseline_for_patch_group(
&self
) -> GetPatchBaselineForPatchGroup
Constructs a fluent builder for the GetPatchBaselineForPatchGroup
operation.
- The fluent builder is configurable:
patch_group(impl Into<String>)
/set_patch_group(Option<String>)
:The name of the patch group whose patch baseline should be retrieved.
operating_system(OperatingSystem)
/set_operating_system(Option<OperatingSystem>)
: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>
sourcepub fn get_service_setting(&self) -> GetServiceSetting
pub fn get_service_setting(&self) -> GetServiceSetting
Constructs a fluent builder for the GetServiceSetting
operation.
- The fluent builder is configurable:
setting_id(impl Into<String>)
/set_setting_id(Option<String>)
:The ID of the service setting to get. The setting ID can be one of the following.
-
/ssm/automation/customer-script-log-destination
-
/ssm/automation/customer-script-log-group-name
-
/ssm/documents/console/public-sharing-permission
-
/ssm/parameter-store/default-parameter-tier
-
/ssm/parameter-store/high-throughput-enabled
-
/ssm/managed-instance/activation-tier
-
- 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>
sourcepub fn label_parameter_version(&self) -> LabelParameterVersion
pub fn label_parameter_version(&self) -> LabelParameterVersion
Constructs a fluent builder for the LabelParameterVersion
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The parameter name on which you want to attach one or more labels.
parameter_version(i64)
/set_parameter_version(Option<i64>)
: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(Vec<String>)
/set_labels(Option<Vec<String>>)
: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 Labeling parameters 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>
sourcepub fn list_associations(&self) -> ListAssociations
pub fn list_associations(&self) -> ListAssociations
Constructs a fluent builder for the ListAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
association_filter_list(Vec<AssociationFilter>)
/set_association_filter_list(Option<Vec<AssociationFilter>>)
: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 theInstanceID
attribute. Associations targeting the managed node that are part of the Target AttributesResourceGroup
orTags
aren’t returned.max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn list_association_versions(&self) -> ListAssociationVersions
pub fn list_association_versions(&self) -> ListAssociationVersions
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>)
:The association ID for which you want to view all versions.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn list_command_invocations(&self) -> ListCommandInvocations
pub fn list_command_invocations(&self) -> ListCommandInvocations
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>)
:(Optional) The invocations for a specific command ID.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:(Optional) The command execution details for a specific managed node ID.
max_results(i32)
/set_max_results(Option<i32>)
:(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>)
:(Optional) The token for the next set of items to return. (You received this token from a previous call.)
filters(Vec<CommandFilter>)
/set_filters(Option<Vec<CommandFilter>>)
:(Optional) One or more filters. Use a filter to return a more specific list of results.
details(bool)
/set_details(bool)
:(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>
sourcepub fn list_commands(&self) -> ListCommands
pub fn list_commands(&self) -> ListCommands
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>)
:(Optional) If provided, lists only the specified command.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:(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>)
:(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>)
:(Optional) The token for the next set of items to return. (You received this token from a previous call.)
filters(Vec<CommandFilter>)
/set_filters(Option<Vec<CommandFilter>>)
:(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>
sourcepub fn list_compliance_items(&self) -> ListComplianceItems
pub fn list_compliance_items(&self) -> ListComplianceItems
Constructs a fluent builder for the ListComplianceItems
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<ComplianceStringFilter>)
/set_filters(Option<Vec<ComplianceStringFilter>>)
:One or more compliance filters. Use a filter to return a more specific list of results.
resource_ids(Vec<String>)
/set_resource_ids(Option<Vec<String>>)
:The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.
resource_types(Vec<String>)
/set_resource_types(Option<Vec<String>>)
: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>)
:A token to start the list. Use this token to get the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_compliance_summaries(&self) -> ListComplianceSummaries
pub fn list_compliance_summaries(&self) -> ListComplianceSummaries
Constructs a fluent builder for the ListComplianceSummaries
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<ComplianceStringFilter>)
/set_filters(Option<Vec<ComplianceStringFilter>>)
: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>)
:A token to start the list. Use this token to get the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_document_metadata_history(&self) -> ListDocumentMetadataHistory
pub fn list_document_metadata_history(&self) -> ListDocumentMetadataHistory
Constructs a fluent builder for the ListDocumentMetadataHistory
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the change template.
document_version(impl Into<String>)
/set_document_version(Option<String>)
:The version of the change template.
metadata(DocumentMetadataEnum)
/set_metadata(Option<DocumentMetadataEnum>)
: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>)
: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>)
: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>
sourcepub fn list_documents(&self) -> ListDocuments
pub fn list_documents(&self) -> ListDocuments
Constructs a fluent builder for the ListDocuments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
document_filter_list(Vec<DocumentFilter>)
/set_document_filter_list(Option<Vec<DocumentFilter>>)
:This data type is deprecated. Instead, use
Filters
.filters(Vec<DocumentKeyValuesFilter>)
/set_filters(Option<Vec<DocumentKeyValuesFilter>>)
: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 includeOwner
,Name
,PlatformTypes
,DocumentType
, andTargetType
. For example, to return documents you own useKey=Owner,Values=Self
. To specify a custom key-value pair, use the formatKey=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>)
: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>)
: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>
sourcepub fn list_document_versions(&self) -> ListDocumentVersions
pub fn list_document_versions(&self) -> ListDocumentVersions
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>)
:The name of the document. You can specify an Amazon Resource Name (ARN).
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn list_inventory_entries(&self) -> ListInventoryEntries
pub fn list_inventory_entries(&self) -> ListInventoryEntries
Constructs a fluent builder for the ListInventoryEntries
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The managed node ID for which you want inventory information.
type_name(impl Into<String>)
/set_type_name(Option<String>)
:The type of inventory item for which you want information.
filters(Vec<InventoryFilter>)
/set_filters(Option<Vec<InventoryFilter>>)
: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>)
: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>)
: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 node(s).
capture_time(Option<String>)
:The time that inventory information was collected for the managed node(s).
entries(Option<Vec<HashMap<String, String>>>)
:A list of inventory items on the managed node(s).
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>
sourcepub fn list_ops_item_events(&self) -> ListOpsItemEvents
pub fn list_ops_item_events(&self) -> ListOpsItemEvents
Constructs a fluent builder for the ListOpsItemEvents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<OpsItemEventFilter>)
/set_filters(Option<Vec<OpsItemEventFilter>>)
:One or more OpsItem filters. Use a filter to return a more specific list of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
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>)
:The ID of the OpsItem for which you want to list all related-item resources.
filters(Vec<OpsItemRelatedItemsFilter>)
/set_filters(Option<Vec<OpsItemRelatedItemsFilter>>)
:One or more OpsItem filters. Use a filter to return a more specific list of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn list_ops_metadata(&self) -> ListOpsMetadata
pub fn list_ops_metadata(&self) -> ListOpsMetadata
Constructs a fluent builder for the ListOpsMetadata
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<OpsMetadataFilter>)
/set_filters(Option<Vec<OpsMetadataFilter>>)
:One or more filters to limit the number of OpsMetadata objects returned by the call.
max_results(i32)
/set_max_results(Option<i32>)
: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>)
: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>
sourcepub fn list_resource_compliance_summaries(
&self
) -> ListResourceComplianceSummaries
pub fn list_resource_compliance_summaries(
&self
) -> ListResourceComplianceSummaries
Constructs a fluent builder for the ListResourceComplianceSummaries
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<ComplianceStringFilter>)
/set_filters(Option<Vec<ComplianceStringFilter>>)
: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>)
:A token to start the list. Use this token to get the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_resource_data_sync(&self) -> ListResourceDataSync
pub fn list_resource_data_sync(&self) -> ListResourceDataSync
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>)
: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. SpecifySyncFromSource
to view resource data syncs from Organizations or from multiple Amazon Web Services Regions.next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token to start the list. Use this token to get the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_type(ResourceTypeForTagging)
/set_resource_type(Option<ResourceTypeForTagging>)
:Returns a list of tags for a specific resource type.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
: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>
sourcepub fn modify_document_permission(&self) -> ModifyDocumentPermission
pub fn modify_document_permission(&self) -> ModifyDocumentPermission
Constructs a fluent builder for the ModifyDocumentPermission
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the document that you want to share.
permission_type(DocumentPermissionType)
/set_permission_type(Option<DocumentPermissionType>)
:The permission type for the document. The permission type can be Share.
account_ids_to_add(Vec<String>)
/set_account_ids_to_add(Option<Vec<String>>)
:The Amazon Web Services user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.
account_ids_to_remove(Vec<String>)
/set_account_ids_to_remove(Option<Vec<String>>)
:The Amazon Web Services user accounts that should no longer have access to the document. The Amazon Web Services user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account 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>)
:(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>
sourcepub fn put_compliance_items(&self) -> PutComplianceItems
pub fn put_compliance_items(&self) -> PutComplianceItems
Constructs a fluent builder for the PutComplianceItems
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
: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>)
:Specify the type of resource.
ManagedInstance
is currently the only supported resource type.compliance_type(impl Into<String>)
/set_compliance_type(Option<String>)
: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>)
: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(Vec<ComplianceItemEntry>)
/set_items(Option<Vec<ComplianceItemEntry>>)
: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>)
: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>)
:The mode for uploading compliance items. You can specify
COMPLETE
orPARTIAL
. InCOMPLETE
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 withSyncCompliance
set toMANUAL
. By default, all requests useCOMPLETE
mode.This attribute is only valid for association compliance.
- On success, responds with
PutComplianceItemsOutput
- On failure, responds with
SdkError<PutComplianceItemsError>
sourcepub fn put_inventory(&self) -> PutInventory
pub fn put_inventory(&self) -> PutInventory
Constructs a fluent builder for the PutInventory
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:An managed node ID where you want to add or update inventory items.
items(Vec<InventoryItem>)
/set_items(Option<Vec<InventoryItem>>)
: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>
sourcepub fn put_parameter(&self) -> PutParameter
pub fn put_parameter(&self) -> PutParameter
Constructs a fluent builder for the PutParameter
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The fully qualified name of the parameter that you want to add to the system. 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>)
: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>)
: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
{{}}
or{{ssm:parameter-name}}
in a parameter value.r#type(ParameterType)
/set_type(Option<ParameterType>)
: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 theString
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>)
:The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Either the default KMS key automatically assigned to your Amazon Web Services account or a custom key. 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.
-
To use your default KMS key, choose the
SecureString
data type, and do not specify theKey ID
when you create the parameter. The system automatically populatesKey ID
with your default KMS key. -
To use a custom KMS key, choose the
SecureString
data type with theKey ID
parameter.
-
overwrite(bool)
/set_overwrite(Option<bool>)
:Overwrite an existing parameter. The default value is
false
.allowed_pattern(impl Into<String>)
/set_allowed_pattern(Option<String>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>)
: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 Standard and advanced 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>)
:One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a capability of 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>)
: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 specifyaws:ec2:image
, Amazon Web Services Systems Manager validates the parameter value is in the required format, such asami-12345abcdeEXAMPLE
, and that the specified AMI is available in your Amazon Web Services account. For more information, see Native parameter support for Amazon Machine Image (AMI) IDs in the Amazon Web Services Systems Manager User Guide.-
- 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>
sourcepub fn register_default_patch_baseline(&self) -> RegisterDefaultPatchBaseline
pub fn register_default_patch_baseline(&self) -> RegisterDefaultPatchBaseline
Constructs a fluent builder for the RegisterDefaultPatchBaseline
operation.
- The fluent builder is configurable:
baseline_id(impl Into<String>)
/set_baseline_id(Option<String>)
: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>
sourcepub fn register_patch_baseline_for_patch_group(
&self
) -> RegisterPatchBaselineForPatchGroup
pub fn register_patch_baseline_for_patch_group(
&self
) -> RegisterPatchBaselineForPatchGroup
Constructs a fluent builder for the RegisterPatchBaselineForPatchGroup
operation.
- The fluent builder is configurable:
baseline_id(impl Into<String>)
/set_baseline_id(Option<String>)
:The ID of the patch baseline to register with the patch group.
patch_group(impl Into<String>)
/set_patch_group(Option<String>)
: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>
sourcepub fn register_target_with_maintenance_window(
&self
) -> RegisterTargetWithMaintenanceWindow
pub fn register_target_with_maintenance_window(
&self
) -> RegisterTargetWithMaintenanceWindow
Constructs a fluent builder for the RegisterTargetWithMaintenanceWindow
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
:The ID of the maintenance window the target should be registered with.
resource_type(MaintenanceWindowResourceType)
/set_resource_type(Option<MaintenanceWindowResourceType>)
:The type of target being registered with the maintenance window.
targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
: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 formatKey=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>)
: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>)
:An optional name for the target.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description for the target.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn register_task_with_maintenance_window(
&self
) -> RegisterTaskWithMaintenanceWindow
pub fn register_task_with_maintenance_window(
&self
) -> RegisterTaskWithMaintenanceWindow
Constructs a fluent builder for the RegisterTaskWithMaintenanceWindow
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
:The ID of the maintenance window the task should be added to.
targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
: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>)
:The ARN of the task to run.
service_role_arn(impl Into<String>)
/set_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 your account’s service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run
RegisterTaskWithMaintenanceWindow
.For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:
task_type(MaintenanceWindowTaskType)
/set_task_type(Option<MaintenanceWindowTaskType>)
:The type of task being registered.
task_parameters(HashMap<String, MaintenanceWindowTaskParameterValueExpression>)
/set_task_parameters(Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>)
: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 theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, seeMaintenanceWindowTaskInvocationParameters
.task_invocation_parameters(MaintenanceWindowTaskInvocationParameters)
/set_task_invocation_parameters(Option<MaintenanceWindowTaskInvocationParameters>)
: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>)
: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>)
: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>)
: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>)
: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 theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, seeMaintenanceWindowTaskInvocationParameters
.name(impl Into<String>)
/set_name(Option<String>)
:An optional name for the task.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description for the task.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:User-provided idempotency token.
cutoff_behavior(MaintenanceWindowTaskCutoffBehavior)
/set_cutoff_behavior(Option<MaintenanceWindowTaskCutoffBehavior>)
: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
. -
-
- 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>
Constructs a fluent builder for the RemoveTagsFromResource
operation.
- The fluent builder is configurable:
resource_type(ResourceTypeForTagging)
/set_resource_type(Option<ResourceTypeForTagging>)
: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>)
: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 wordopsmetadata
in the ARN. For example, an OpsMetadata object with an ARN ofarn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager
has aResourceID
of eitheraws/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(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:Tag keys that you want to remove from the specified resource.
- On success, responds with
RemoveTagsFromResourceOutput
- On failure, responds with
SdkError<RemoveTagsFromResourceError>
sourcepub fn reset_service_setting(&self) -> ResetServiceSetting
pub fn reset_service_setting(&self) -> ResetServiceSetting
Constructs a fluent builder for the ResetServiceSetting
operation.
- The fluent builder is configurable:
setting_id(impl Into<String>)
/set_setting_id(Option<String>)
:The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following.
-
/ssm/automation/customer-script-log-destination
-
/ssm/automation/customer-script-log-group-name
-
/ssm/documents/console/public-sharing-permission
-
/ssm/parameter-store/default-parameter-tier
-
/ssm/parameter-store/high-throughput-enabled
-
/ssm/managed-instance/activation-tier
-
- 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>
sourcepub fn resume_session(&self) -> ResumeSession
pub fn resume_session(&self) -> ResumeSession
Constructs a fluent builder for the ResumeSession
operation.
- The fluent builder is configurable:
session_id(impl Into<String>)
/set_session_id(Option<String>)
: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>
sourcepub fn send_automation_signal(&self) -> SendAutomationSignal
pub fn send_automation_signal(&self) -> SendAutomationSignal
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>)
:The unique identifier for an existing Automation execution that you want to send the signal to.
signal_type(SignalType)
/set_signal_type(Option<SignalType>)
:The type of signal to send to an Automation execution.
payload(HashMap<String, Vec<String>>)
/set_payload(Option<HashMap<String, Vec<String>>>)
:The data sent with the signal. The data schema depends on the type of signal used in the request.
For
Approve
andReject
signal types, the payload is an optional comment that you can send with the signal type. For example:Comment=“Looks good”
For
StartStep
andResume
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>
sourcepub fn send_command(&self) -> SendCommand
pub fn send_command(&self) -> SendCommand
Constructs a fluent builder for the SendCommand
operation.
- The fluent builder is configurable:
instance_ids(Vec<String>)
/set_instance_ids(Option<Vec<String>>)
: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. UsingTargets
, 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 Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.
targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
: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. UsingTargets
, 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 Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.
document_name(impl Into<String>)
/set_document_name(Option<String>)
: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 Using shared 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>)
: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>)
: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>)
:Sha256 or Sha1.
Sha1 hashes have been deprecated.
timeout_seconds(i32)
/set_timeout_seconds(Option<i32>)
: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>)
:User-specified information about the command, such as a brief description of what the command should do.
parameters(HashMap<String, Vec<String>>)
/set_parameters(Option<HashMap<String, Vec<String>>>)
:The required and optional parameters specified in the document being run.
output_s3_region(impl Into<String>)
/set_output_s3_region(Option<String>)
:(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>)
: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>)
:The directory structure within the S3 bucket where the responses should be stored.
max_concurrency(impl Into<String>)
/set_max_concurrency(Option<String>)
:(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 useMaxConcurrency
, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.max_errors(impl Into<String>)
/set_max_errors(Option<String>)
: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 is0
. For more information about how to useMaxErrors
, 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>)
: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.
notification_config(NotificationConfig)
/set_notification_config(Option<NotificationConfig>)
:Configurations for sending notifications.
cloud_watch_output_config(CloudWatchOutputConfig)
/set_cloud_watch_output_config(Option<CloudWatchOutputConfig>)
:Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
- 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>
sourcepub fn start_associations_once(&self) -> StartAssociationsOnce
pub fn start_associations_once(&self) -> StartAssociationsOnce
Constructs a fluent builder for the StartAssociationsOnce
operation.
- The fluent builder is configurable:
association_ids(Vec<String>)
/set_association_ids(Option<Vec<String>>)
:The association IDs that you want to run immediately and only one time.
- On success, responds with
StartAssociationsOnceOutput
- On failure, responds with
SdkError<StartAssociationsOnceError>
sourcepub fn start_automation_execution(&self) -> StartAutomationExecution
pub fn start_automation_execution(&self) -> StartAutomationExecution
Constructs a fluent builder for the StartAutomationExecution
operation.
- The fluent builder is configurable:
document_name(impl Into<String>)
/set_document_name(Option<String>)
: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 Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.
document_version(impl Into<String>)
/set_document_version(Option<String>)
:The version of the Automation runbook to use for this execution.
parameters(HashMap<String, Vec<String>>)
/set_parameters(Option<HashMap<String, Vec<String>>>)
: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>)
: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>)
: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>)
:The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
:A key-value mapping to target resources. Required if you specify TargetParameterName.
target_maps(Vec<HashMap<String, Vec<String>>>)
/set_target_maps(Option<Vec<HashMap<String, Vec<String>>>>)
: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>)
: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
.max_errors(impl Into<String>)
/set_max_errors(Option<String>)
: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.
target_locations(Vec<TargetLocation>)
/set_target_locations(Option<Vec<TargetLocation>>)
: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 Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the Amazon Web Services Systems Manager User Guide.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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
To add tags to an existing automation, use the
AddTagsToResource
operation.-
- 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>
sourcepub fn start_change_request_execution(&self) -> StartChangeRequestExecution
pub fn start_change_request_execution(&self) -> StartChangeRequestExecution
Constructs a fluent builder for the StartChangeRequestExecution
operation.
- The fluent builder is configurable:
scheduled_time(DateTime)
/set_scheduled_time(Option<DateTime>)
: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>)
:The name of the change template document to run during the runbook workflow.
document_version(impl Into<String>)
/set_document_version(Option<String>)
:The version of the change template document to run during the runbook workflow.
parameters(HashMap<String, Vec<String>>)
/set_parameters(Option<HashMap<String, Vec<String>>>)
: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>)
:The name of the change request associated with the runbook workflow to be run.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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(bool)
:Indicates whether the change request can be approved automatically without the need for manual approvals.
If
AutoApprovable
is enabled in a change template, then settingAutoApprove
totrue
inStartChangeRequestExecution
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 againOPEN
.runbooks(Vec<Runbook>)
/set_runbooks(Option<Vec<Runbook>>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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
-
scheduled_end_time(DateTime)
/set_scheduled_end_time(Option<DateTime>)
: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>)
: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>
sourcepub fn start_session(&self) -> StartSession
pub fn start_session(&self) -> StartSession
Constructs a fluent builder for the StartSession
operation.
- The fluent builder is configurable:
target(impl Into<String>)
/set_target(Option<String>)
:The managed node to connect to for the session.
document_name(impl Into<String>)
/set_document_name(Option<String>)
:The name of the SSM document to define the parameters and plugin settings for the session. For example,
SSM-SessionManagerRunShell
. You can call theGetDocument
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.reason(impl Into<String>)
/set_reason(Option<String>)
: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(HashMap<String, Vec<String>>)
/set_parameters(Option<HashMap<String, Vec<String>>>)
:The values you want to specify for the parameters defined in the Session document.
- 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. 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 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>
sourcepub fn stop_automation_execution(&self) -> StopAutomationExecution
pub fn stop_automation_execution(&self) -> StopAutomationExecution
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>)
:The execution ID of the Automation to stop.
r#type(StopType)
/set_type(Option<StopType>)
: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>
sourcepub fn terminate_session(&self) -> TerminateSession
pub fn terminate_session(&self) -> TerminateSession
Constructs a fluent builder for the TerminateSession
operation.
- The fluent builder is configurable:
session_id(impl Into<String>)
/set_session_id(Option<String>)
: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>
sourcepub fn unlabel_parameter_version(&self) -> UnlabelParameterVersion
pub fn unlabel_parameter_version(&self) -> UnlabelParameterVersion
Constructs a fluent builder for the UnlabelParameterVersion
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the parameter from which you want to delete one or more labels.
parameter_version(i64)
/set_parameter_version(Option<i64>)
: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(Vec<String>)
/set_labels(Option<Vec<String>>)
: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>
sourcepub fn update_association(&self) -> UpdateAssociation
pub fn update_association(&self) -> UpdateAssociation
Constructs a fluent builder for the UpdateAssociation
operation.
- The fluent builder is configurable:
association_id(impl Into<String>)
/set_association_id(Option<String>)
:The ID of the association you want to update.
parameters(HashMap<String, Vec<String>>)
/set_parameters(Option<HashMap<String, Vec<String>>>)
:The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using
{{ssm:parameter-name}}
.document_version(impl Into<String>)
/set_document_version(Option<String>)
: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 todefault
.schedule_expression(impl Into<String>)
/set_schedule_expression(Option<String>)
:The cron expression used to schedule the association that you want to update.
output_location(InstanceAssociationOutputLocation)
/set_output_location(Option<InstanceAssociationOutputLocation>)
:An S3 bucket where you want to store the results of this request.
name(impl Into<String>)
/set_name(Option<String>)
: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
orMy-Document
.targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
:The targets of the association.
association_name(impl Into<String>)
/set_association_name(Option<String>)
:The name of the association that you want to update.
association_version(impl Into<String>)
/set_association_version(Option<String>)
: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>)
: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 capability of Amazon Web Services Systems Manager.
max_errors(impl Into<String>)
/set_max_errors(Option<String>)
: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, setMaxConcurrency
to 1 so that executions proceed one at a time.max_concurrency(impl Into<String>)
/set_max_concurrency(Option<String>)
: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 forMaxConcurrency
.compliance_severity(AssociationComplianceSeverity)
/set_compliance_severity(Option<AssociationComplianceSeverity>)
:The severity level to assign to the association.
sync_compliance(AssociationSyncCompliance)
/set_sync_compliance(Option<AssociationSyncCompliance>)
:The mode for generating association compliance. You can specify
AUTO
orMANUAL
. InAUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association isCOMPLIANT
. If the association execution doesn’t run successfully, the association isNON-COMPLIANT
.In
MANUAL
mode, you must specify theAssociationId
as a parameter for thePutComplianceItems
API operation. In this case, compliance data isn’t managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to thePutComplianceItems
API operation.By default, all associations use
AUTO
mode.apply_only_at_cron_interval(bool)
/set_apply_only_at_cron_interval(bool)
: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(Vec<String>)
/set_calendar_names(Option<Vec<String>>)
: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(Vec<TargetLocation>)
/set_target_locations(Option<Vec<TargetLocation>>)
: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>)
: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.
- 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>
sourcepub fn update_association_status(&self) -> UpdateAssociationStatus
pub fn update_association_status(&self) -> UpdateAssociationStatus
Constructs a fluent builder for the UpdateAssociationStatus
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the SSM document.
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The managed node ID.
association_status(AssociationStatus)
/set_association_status(Option<AssociationStatus>)
: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>
sourcepub fn update_document(&self) -> UpdateDocument
pub fn update_document(&self) -> UpdateDocument
Constructs a fluent builder for the UpdateDocument
operation.
- The fluent builder is configurable:
content(impl Into<String>)
/set_content(Option<String>)
:A valid JSON or YAML string.
attachments(Vec<AttachmentsSource>)
/set_attachments(Option<Vec<AttachmentsSource>>)
:A list of key-value pairs that describe attachments to a version of a document.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the SSM document that you want to update.
display_name(impl Into<String>)
/set_display_name(Option<String>)
: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>)
:An optional field specifying the version of the artifact you are updating with the document. For example, “Release 12, Update 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>)
: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>)
: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>)
: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>
sourcepub fn update_document_default_version(&self) -> UpdateDocumentDefaultVersion
pub fn update_document_default_version(&self) -> UpdateDocumentDefaultVersion
Constructs a fluent builder for the UpdateDocumentDefaultVersion
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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>)
: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>
sourcepub fn update_document_metadata(&self) -> UpdateDocumentMetadata
pub fn update_document_metadata(&self) -> UpdateDocumentMetadata
Constructs a fluent builder for the UpdateDocumentMetadata
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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>)
:The version of a change template in which to update approval metadata.
document_reviews(DocumentReviews)
/set_document_reviews(Option<DocumentReviews>)
:The change template review details to update.
- On success, responds with
UpdateDocumentMetadataOutput
- On failure, responds with
SdkError<UpdateDocumentMetadataError>
sourcepub fn update_maintenance_window(&self) -> UpdateMaintenanceWindow
pub fn update_maintenance_window(&self) -> UpdateMaintenanceWindow
Constructs a fluent builder for the UpdateMaintenanceWindow
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
:The ID of the maintenance window to update.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the maintenance window.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description for the update request.
start_date(impl Into<String>)
/set_start_date(Option<String>)
: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.end_date(impl Into<String>)
/set_end_date(Option<String>)
: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>)
: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>)
: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>)
: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>)
:The duration of the maintenance window in hours.
cutoff(i32)
/set_cutoff(Option<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)
/set_allow_unassociated_targets(Option<bool>)
:Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
enabled(bool)
/set_enabled(Option<bool>)
:Whether the maintenance window is enabled.
replace(bool)
/set_replace(Option<bool>)
:If
True
, then all fields that are required by theCreateMaintenanceWindow
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(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>
sourcepub fn update_maintenance_window_target(&self) -> UpdateMaintenanceWindowTarget
pub fn update_maintenance_window_target(&self) -> UpdateMaintenanceWindowTarget
Constructs a fluent builder for the UpdateMaintenanceWindowTarget
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
:The maintenance window ID with which to modify the target.
window_target_id(impl Into<String>)
/set_window_target_id(Option<String>)
:The target ID to modify.
targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
:The targets to add or replace.
owner_information(impl Into<String>)
/set_owner_information(Option<String>)
: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>)
:A name for the update.
description(impl Into<String>)
/set_description(Option<String>)
:An optional description for the update.
replace(bool)
/set_replace(Option<bool>)
:If
True
, then all fields that are required by theRegisterTargetWithMaintenanceWindow
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>
sourcepub fn update_maintenance_window_task(&self) -> UpdateMaintenanceWindowTask
pub fn update_maintenance_window_task(&self) -> UpdateMaintenanceWindowTask
Constructs a fluent builder for the UpdateMaintenanceWindowTask
operation.
- The fluent builder is configurable:
window_id(impl Into<String>)
/set_window_id(Option<String>)
:The maintenance window ID that contains the task to modify.
window_task_id(impl Into<String>)
/set_window_task_id(Option<String>)
:The task ID to modify.
targets(Vec<Target>)
/set_targets(Option<Vec<Target>>)
: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 formatKey=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>)
:The task ARN to modify.
service_role_arn(impl Into<String>)
/set_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 your account’s service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run
RegisterTaskWithMaintenanceWindow
.For more information, see the following topics in the in the Amazon Web Services Systems Manager User Guide:
task_parameters(HashMap<String, MaintenanceWindowTaskParameterValueExpression>)
/set_task_parameters(Option<HashMap<String, MaintenanceWindowTaskParameterValueExpression>>)
:The parameters to modify.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead use theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, seeMaintenanceWindowTaskInvocationParameters
.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>)
: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 theTaskInvocationParameters
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 specifiedTaskInvocationParameters
values forComment
,NotificationConfig
, andOutputS3BucketName
. If you update the maintenance window task and specify only a differentOutputS3BucketName
value, the values forComment
andNotificationConfig
are removed.priority(i32)
/set_priority(Option<i32>)
: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>)
: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>)
: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>)
: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 theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, seeMaintenanceWindowTaskInvocationParameters
.name(impl Into<String>)
/set_name(Option<String>)
:The new task name to specify.
description(impl Into<String>)
/set_description(Option<String>)
:The new task description to specify.
replace(bool)
/set_replace(Option<bool>)
: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>)
: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
. -
-
- 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 Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
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 theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, seeMaintenanceWindowTaskInvocationParameters
.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 theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, seeMaintenanceWindowTaskInvocationParameters
.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.
- On failure, responds with
SdkError<UpdateMaintenanceWindowTaskError>
sourcepub fn update_managed_instance_role(&self) -> UpdateManagedInstanceRole
pub fn update_managed_instance_role(&self) -> UpdateManagedInstanceRole
Constructs a fluent builder for the UpdateManagedInstanceRole
operation.
- The fluent builder is configurable:
instance_id(impl Into<String>)
/set_instance_id(Option<String>)
:The ID of the managed node where you want to update the role.
iam_role(impl Into<String>)
/set_iam_role(Option<String>)
:The IAM role you want to assign or change.
- On success, responds with
UpdateManagedInstanceRoleOutput
- On failure, responds with
SdkError<UpdateManagedInstanceRoleError>
sourcepub fn update_ops_item(&self) -> UpdateOpsItem
pub fn update_ops_item(&self) -> UpdateOpsItem
Constructs a fluent builder for the UpdateOpsItem
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.
operational_data(HashMap<String, OpsItemDataValue>)
/set_operational_data(Option<HashMap<String, OpsItemDataValue>>)
: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 theGetOpsItem
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(Vec<String>)
/set_operational_data_to_delete(Option<Vec<String>>)
:Keys that you want to remove from the OperationalData map.
notifications(Vec<OpsItemNotification>)
/set_notifications(Option<Vec<OpsItemNotification>>)
: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>)
:The importance of this OpsItem in relation to other OpsItems in the system.
related_ops_items(Vec<RelatedOpsItem>)
/set_related_ops_items(Option<Vec<RelatedOpsItem>>)
: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>)
:The OpsItem status. Status can be
Open
,In Progress
, orResolved
. 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>)
:The ID of the OpsItem.
title(impl Into<String>)
/set_title(Option<String>)
:A short heading that describes the nature of the OpsItem and the impacted resource.
category(impl Into<String>)
/set_category(Option<String>)
:Specify a new category for an OpsItem.
severity(impl Into<String>)
/set_severity(Option<String>)
:Specify a new severity for an OpsItem.
actual_start_time(DateTime)
/set_actual_start_time(Option<DateTime>)
: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>)
: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>)
: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>)
:The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type
/aws/changerequest
.
- On success, responds with
UpdateOpsItemOutput
- On failure, responds with
SdkError<UpdateOpsItemError>
sourcepub fn update_ops_metadata(&self) -> UpdateOpsMetadata
pub fn update_ops_metadata(&self) -> UpdateOpsMetadata
Constructs a fluent builder for the UpdateOpsMetadata
operation.
- The fluent builder is configurable:
ops_metadata_arn(impl Into<String>)
/set_ops_metadata_arn(Option<String>)
:The Amazon Resource Name (ARN) of the OpsMetadata Object to update.
metadata_to_update(HashMap<String, MetadataValue>)
/set_metadata_to_update(Option<HashMap<String, MetadataValue>>)
:Metadata to add to an OpsMetadata object.
keys_to_delete(Vec<String>)
/set_keys_to_delete(Option<Vec<String>>)
:The metadata keys to delete from the OpsMetadata object.
- On success, responds with
UpdateOpsMetadataOutput
with field(s):ops_metadata_arn(Option<String>)
:The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.
- On failure, responds with
SdkError<UpdateOpsMetadataError>
sourcepub fn update_patch_baseline(&self) -> UpdatePatchBaseline
pub fn update_patch_baseline(&self) -> UpdatePatchBaseline
Constructs a fluent builder for the UpdatePatchBaseline
operation.
- The fluent builder is configurable:
baseline_id(impl Into<String>)
/set_baseline_id(Option<String>)
:The ID of the patch baseline to update.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the patch baseline.
global_filters(PatchFilterGroup)
/set_global_filters(Option<PatchFilterGroup>)
:A set of global filters used to include patches in the baseline.
approval_rules(PatchRuleGroup)
/set_approval_rules(Option<PatchRuleGroup>)
:A set of rules used to include patches in the baseline.
approved_patches(Vec<String>)
/set_approved_patches(Option<Vec<String>>)
:A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About 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>)
:Assigns a new compliance severity level to an existing patch baseline.
approved_patches_enable_non_security(bool)
/set_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(Vec<String>)
/set_rejected_patches(Option<Vec<String>>)
:A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see About 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>)
:The action for Patch Manager to take on patches included in the
RejectedPackages
list.-
ALLOW_AS_DEPENDENCY
: A package in theRejected
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 asInstalledOther
. This is the default action if no option is specified. -
BLOCK
: Packages in theRejectedPatches
list, and packages that include them as dependencies, aren’t installed under any circumstances. If a package was installed before it was added to theRejected
patches list, it is considered non-compliant with the patch baseline, and its status is reported asInstalledRejected
.
-
description(impl Into<String>)
/set_description(Option<String>)
:A description of the patch baseline.
sources(Vec<PatchSource>)
/set_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.
replace(bool)
/set_replace(Option<bool>)
:If True, then all fields that are required by the
CreatePatchBaseline
operation are also required for this API request. Optional fields that aren’t specified are set to null.
- On success, responds with
UpdatePatchBaselineOutput
with field(s):baseline_id(Option<String>)
:The ID of the deleted patch baseline.
name(Option<String>)
:The name of the patch baseline.
operating_system(Option<OperatingSystem>)
:The operating system rule used by the updated 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>)
:The compliance severity level assigned to the patch baseline after the update completed.
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.created_date(Option<DateTime>)
:The date when the patch baseline was created.
modified_date(Option<DateTime>)
:The date when 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<UpdatePatchBaselineError>
sourcepub fn update_resource_data_sync(&self) -> UpdateResourceDataSync
pub fn update_resource_data_sync(&self) -> UpdateResourceDataSync
Constructs a fluent builder for the UpdateResourceDataSync
operation.
- The fluent builder is configurable:
sync_name(impl Into<String>)
/set_sync_name(Option<String>)
:The name of the resource data sync you want to update.
sync_type(impl Into<String>)
/set_sync_type(Option<String>)
:The type of resource data sync. The supported
SyncType
is SyncFromSource.sync_source(ResourceDataSyncSource)
/set_sync_source(Option<ResourceDataSyncSource>)
:Specify information about the data sources to synchronize.
- On success, responds with
UpdateResourceDataSyncOutput
- On failure, responds with
SdkError<UpdateResourceDataSyncError>
sourcepub fn update_service_setting(&self) -> UpdateServiceSetting
pub fn update_service_setting(&self) -> UpdateServiceSetting
Constructs a fluent builder for the UpdateServiceSetting
operation.
- The fluent builder is configurable:
setting_id(impl Into<String>)
/set_setting_id(Option<String>)
:The Amazon Resource Name (ARN) of the service setting to reset. For example,
arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled
. The setting ID can be one of the following.-
/ssm/automation/customer-script-log-destination
-
/ssm/automation/customer-script-log-group-name
-
/ssm/documents/console/public-sharing-permission
-
/ssm/parameter-store/default-parameter-tier
-
/ssm/parameter-store/high-throughput-enabled
-
/ssm/managed-instance/activation-tier
-
setting_value(impl Into<String>)
/set_setting_value(Option<String>)
:The new value to specify for the service setting. The following list specifies the available values for each setting.
-
/ssm/parameter-store/default-parameter-tier
:Standard
,Advanced
,Intelligent-Tiering
-
/ssm/parameter-store/high-throughput-enabled
:true
orfalse
-
/ssm/managed-instance/activation-tier
:true
orfalse
-
/ssm/automation/customer-script-log-destination
:CloudWatch
-
/ssm/automation/customer-script-log-group-name
: the name of an Amazon CloudWatch Logs log group -
/ssm/documents/console/public-sharing-permission
:Enable
orDisable
-
/ssm/managed-instance/activation-tier
:standard
oradvanced
-
- On success, responds with
UpdateServiceSettingOutput
- On failure, responds with
SdkError<UpdateServiceSettingError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more