Struct aws_sdk_ssm::client::fluent_builders::CreateOpsItem

pub struct CreateOpsItem<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateOpsItem.

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Implementations

impl<C, M, R> CreateOpsItem<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateOpsItemOutput, SdkError<CreateOpsItemError>> where
    R::Policy: SmithyRetryPolicy<CreateOpsItemInputOperationOutputAlias, CreateOpsItemOutput, CreateOpsItemError, CreateOpsItemInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn description(self, inp: impl Into<String>) -> Self

Information about the OpsItem.

pub fn set_description(self, input: Option<String>) -> Self

Information about the OpsItem.

pub fn ops_item_type(self, inp: impl Into<String>) -> Self

The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.

pub fn set_ops_item_type(self, input: Option<String>) -> Self

The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.

pub fn operational_data(
    self,
    k: impl Into<String>,
    v: impl Into<OpsItemDataValue>
) -> Self

Adds a key-value pair to OperationalData.

To override the contents of this collection use set_operational_data.

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

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

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

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

pub fn set_operational_data(
    self,
    input: Option<HashMap<String, OpsItemDataValue>>
) -> Self

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

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

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

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

pub fn notifications(self, inp: impl Into<OpsItemNotification>) -> Self

Appends an item to Notifications.

To override the contents of this collection use set_notifications.

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

pub fn set_notifications(self, input: Option<Vec<OpsItemNotification>>) -> Self

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

pub fn priority(self, inp: i32) -> Self

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

pub fn set_priority(self, input: Option<i32>) -> Self

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

pub fn related_ops_items(self, inp: impl Into<RelatedOpsItem>) -> Self

Appends an item to RelatedOpsItems.

To override the contents of this collection use set_related_ops_items.

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.

pub fn set_related_ops_items(self, input: Option<Vec<RelatedOpsItem>>) -> Self

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.

pub fn source(self, inp: impl Into<String>) -> Self

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

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

pub fn set_source(self, input: Option<String>) -> Self

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

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

pub fn title(self, inp: impl Into<String>) -> Self

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

pub fn set_title(self, input: Option<String>) -> Self

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

pub fn tags(self, inp: impl Into<Tag>) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

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 the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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 the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

pub fn category(self, inp: impl Into<String>) -> Self

Specify a category to assign to an OpsItem.

pub fn set_category(self, input: Option<String>) -> Self

Specify a category to assign to an OpsItem.

pub fn severity(self, inp: impl Into<String>) -> Self

Specify a severity to assign to an OpsItem.

pub fn set_severity(self, input: Option<String>) -> Self

Specify a severity to assign to an OpsItem.

pub fn actual_start_time(self, inp: DateTime) -> Self

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

pub fn set_actual_start_time(self, input: Option<DateTime>) -> Self

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

pub fn actual_end_time(self, inp: DateTime) -> Self

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

pub fn set_actual_end_time(self, input: Option<DateTime>) -> Self

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

pub fn planned_start_time(self, inp: DateTime) -> Self

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

pub fn set_planned_start_time(self, input: Option<DateTime>) -> Self

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

pub fn planned_end_time(self, inp: DateTime) -> Self

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

pub fn set_planned_end_time(self, input: Option<DateTime>) -> Self

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

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateOpsItem<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.