CreateOpsItemRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.15.50 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ssm.model.SsmRequest
    - - software.amazon.awssdk.services.ssm.model.CreateOpsItemRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateOpsItemRequest
extends SsmRequest
implements ToCopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateOpsItemRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateOpsItemRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Instant`	`actualEndTime()` The time a runbook workflow ended.
`Instant`	`actualStartTime()` The time a runbook workflow started.
`static CreateOpsItemRequest.Builder`	`builder()`
`String`	`category()` Specify a category to assign to an OpsItem.
`String`	`description()` Information about the OpsItem.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasNotifications()` Returns true if the Notifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasOperationalData()` Returns true if the OperationalData property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasRelatedOpsItems()` Returns true if the RelatedOpsItems property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<OpsItemNotification>`	`notifications()` The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
`Map<String,OpsItemDataValue>`	`operationalData()` Operational data is custom data that provides useful reference details about the OpsItem.
`String`	`opsItemType()` The type of OpsItem to create.
`Instant`	`plannedEndTime()` The time specified in a change request for a runbook workflow to end.
`Instant`	`plannedStartTime()` The time specified in a change request for a runbook workflow to start.
`Integer`	`priority()` The importance of this OpsItem in relation to other OpsItems in the system.
`List<RelatedOpsItem>`	`relatedOpsItems()` One or more OpsItems that share something in common with the current OpsItems.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateOpsItemRequest.Builder>`	`serializableBuilderClass()`
`String`	`severity()` Specify a severity to assign to an OpsItem.
`String`	`source()` The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
`List<Tag>`	`tags()` Optional metadata that you assign to a resource.
`String`	`title()` A short heading that describes the nature of the OpsItem and the impacted resource.
`CreateOpsItemRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - description
```
public final String description()
```
    Information about the OpsItem.
    
    Returns:
    
    Information about the OpsItem.
  - opsItemType
```
public final String opsItemType()
```
    The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.
    
    Returns:
    
    The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.
  - hasOperationalData
```
public final boolean hasOperationalData()
```
    Returns true if the OperationalData property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - operationalData
```
public final Map<String,OpsItemDataValue> operationalData()
```
    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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
    
    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 AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasOperationalData() to see if a value was sent in this field.
    
    Returns:
    
    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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
    
    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 AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.
  - hasNotifications
```
public final boolean hasNotifications()
```
    Returns true if the Notifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - notifications
```
public final List<OpsItemNotification> notifications()
```
    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNotifications() to see if a value was sent in this field.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
  - priority
```
public final Integer priority()
```
    The importance of this OpsItem in relation to other OpsItems in the system.
    
    Returns:
    
    The importance of this OpsItem in relation to other OpsItems in the system.
  - hasRelatedOpsItems
```
public final boolean hasRelatedOpsItems()
```
    Returns true if the RelatedOpsItems property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - relatedOpsItems
```
public final List<RelatedOpsItem> relatedOpsItems()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasRelatedOpsItems() to see if a value was sent in this field.
    
    Returns:
    
    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
```
public final String source()
```
    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.
    
    Returns:
    
    The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
    
    The source name can't contain the following strings: aws, amazon, and amzn.
  - title
```
public final String title()
```
    A short heading that describes the nature of the OpsItem and the impacted resource.
    
    Returns:
    
    A short heading that describes the nature of the OpsItem and the impacted resource.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> 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 AWS Systems Manager User Guide.
    
    Tags use a key-value pair. For example:
    
    Key=Department,Value=Finance
    
    To add tags to an existing OpsItem, use the AddTagsToResource action.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    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 AWS Systems Manager User Guide.
    
    Tags use a key-value pair. For example:
    
    Key=Department,Value=Finance
    
    To add tags to an existing OpsItem, use the AddTagsToResource action.
  - category
```
public final String category()
```
    Specify a category to assign to an OpsItem.
    
    Returns:
    
    Specify a category to assign to an OpsItem.
  - severity
```
public final String severity()
```
    Specify a severity to assign to an OpsItem.
    
    Returns:
    
    Specify a severity to assign to an OpsItem.
  - actualStartTime
```
public final Instant actualStartTime()
```
    The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest .
    
    Returns:
    
    The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
  - actualEndTime
```
public final Instant actualEndTime()
```
    The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
  - plannedStartTime
```
public final Instant plannedStartTime()
```
    The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
  - plannedEndTime
```
public final Instant plannedEndTime()
```
    The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
  - toBuilder
```
public CreateOpsItemRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
  - builder
```
public static CreateOpsItemRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateOpsItemRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateOpsItemRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

description

opsItemType

hasOperationalData

operationalData

hasNotifications

notifications

priority

hasRelatedOpsItems

relatedOpsItems

source

title

hasTags

tags

category

severity

actualStartTime

actualEndTime

plannedStartTime

plannedEndTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields