AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Systems Manager CreateOpsItem API operation.

Syntax

New-SSMOpsItem
-Title <String>
-AccountId <String>
-ActualEndTime <DateTime>
-ActualStartTime <DateTime>
-Category <String>
-Description <String>
-Notification <OpsItemNotification[]>
-OperationalData <Hashtable>
-OpsItemType <String>
-PlannedEndTime <DateTime>
-PlannedStartTime <DateTime>
-Priority <Int32>
-RelatedOpsItem <RelatedOpsItem[]>
-Severity <String>
-Source <String>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonSimpleSystemsManagementConfig>

Description

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up 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.

Parameters

-AccountId <String>
The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ActualEndTime <DateTime>
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ActualStartTime <DateTime>
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Category <String>
Specify a category to assign to an OpsItem.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonSimpleSystemsManagementConfig>
Amazon.PowerShell.Cmdlets.SSM.AmazonSimpleSystemsManagementClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
User-defined text that contains information about the OpsItem, in Markdown format.Provide enough information so that users viewing this OpsItem for the first time understand the issue.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notification <OpsItemNotification[]>
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNotifications
-OperationalData <Hashtable>
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Create OpsItems manually in the Amazon Web Services Systems Manager User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpsItemType <String>
The type of OpsItem to create. Systems Manager supports the following types of OpsItems:
  • /aws/issueThis type of OpsItem is used for default OpsItems created by OpsCenter.
  • /aws/changerequestThis type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
  • /aws/insightThis type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Title parameter. The -PassThru parameter is deprecated, use -Select '^Title' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PlannedEndTime <DateTime>
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PlannedStartTime <DateTime>
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Priority <Int32>
The importance of this OpsItem in relation to other OpsItems in the system.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelatedOpsItem <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRelatedOpsItems
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'OpsItemId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CreateOpsItemResponse). Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreateOpsItemResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Severity <String>
Specify a severity to assign to an OpsItem.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Optional metadata that you assign to a resource.Tags use a key-value pair. For example:Key=Department,Value=FinanceTo 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Title <String>
A short heading that describes the nature of the OpsItem and the impacted resource.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.SimpleSystemsManagement.Model.CreateOpsItemResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SimpleSystemsManagement.Model.CreateOpsItemResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Service User Guide
Service API Reference
Microsoft Windows Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z