Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.AssociateOpsItemRelatedItem

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.

Synopsis

data AssociateOpsItemRelatedItem = AssociateOpsItemRelatedItem' {
- opsItemId :: Text
- associationType :: Text
- resourceType :: Text
- resourceUri :: Text
}
newAssociateOpsItemRelatedItem :: Text -> Text -> Text -> Text -> AssociateOpsItemRelatedItem
associateOpsItemRelatedItem_opsItemId :: Lens' AssociateOpsItemRelatedItem Text
associateOpsItemRelatedItem_associationType :: Lens' AssociateOpsItemRelatedItem Text
associateOpsItemRelatedItem_resourceType :: Lens' AssociateOpsItemRelatedItem Text
associateOpsItemRelatedItem_resourceUri :: Lens' AssociateOpsItemRelatedItem Text
data AssociateOpsItemRelatedItemResponse = AssociateOpsItemRelatedItemResponse' {
- associationId :: Maybe Text
- httpStatus :: Int
}
newAssociateOpsItemRelatedItemResponse :: Int -> AssociateOpsItemRelatedItemResponse
associateOpsItemRelatedItemResponse_associationId :: Lens' AssociateOpsItemRelatedItemResponse (Maybe Text)
associateOpsItemRelatedItemResponse_httpStatus :: Lens' AssociateOpsItemRelatedItemResponse Int

Creating a Request

data AssociateOpsItemRelatedItem Source #

See: newAssociateOpsItemRelatedItem smart constructor.

Constructors

AssociateOpsItemRelatedItem'

Fields

opsItemId :: Text
The ID of the OpsItem to which you want to associate a resource as a related item.
associationType :: Text
The type of association that you want to create between an OpsItem and a resource. OpsCenter supports IsParentOf and RelatesTo association types.
resourceType :: Text
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.
resourceUri :: Text
The Amazon Resource Name (ARN) of the Amazon Web Services resource that you want to associate with the OpsItem.

Instances

Instances details

ToJSON AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods toJSON :: AssociateOpsItemRelatedItem -> Value # toEncoding :: AssociateOpsItemRelatedItem -> Encoding # toJSONList :: [AssociateOpsItemRelatedItem] -> Value # toEncodingList :: [AssociateOpsItemRelatedItem] -> Encoding #
ToHeaders AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods toHeaders :: AssociateOpsItemRelatedItem -> [Header] #
ToPath AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods toPath :: AssociateOpsItemRelatedItem -> ByteString #
ToQuery AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods toQuery :: AssociateOpsItemRelatedItem -> QueryString #
AWSRequest AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Associated Types type AWSResponse AssociateOpsItemRelatedItem # Methods request :: (Service -> Service) -> AssociateOpsItemRelatedItem -> Request AssociateOpsItemRelatedItem # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateOpsItemRelatedItem -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateOpsItemRelatedItem))) #
Generic AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Associated Types type Rep AssociateOpsItemRelatedItem :: Type -> Type # Methods from :: AssociateOpsItemRelatedItem -> Rep AssociateOpsItemRelatedItem x # to :: Rep AssociateOpsItemRelatedItem x -> AssociateOpsItemRelatedItem #
Read AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods readsPrec :: Int -> ReadS AssociateOpsItemRelatedItem # readList :: ReadS [AssociateOpsItemRelatedItem] # readPrec :: ReadPrec AssociateOpsItemRelatedItem # readListPrec :: ReadPrec [AssociateOpsItemRelatedItem] #
Show AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods showsPrec :: Int -> AssociateOpsItemRelatedItem -> ShowS # show :: AssociateOpsItemRelatedItem -> String # showList :: [AssociateOpsItemRelatedItem] -> ShowS #
NFData AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods rnf :: AssociateOpsItemRelatedItem -> () #
Eq AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods (==) :: AssociateOpsItemRelatedItem -> AssociateOpsItemRelatedItem -> Bool # (/=) :: AssociateOpsItemRelatedItem -> AssociateOpsItemRelatedItem -> Bool #
Hashable AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods hashWithSalt :: Int -> AssociateOpsItemRelatedItem -> Int # hash :: AssociateOpsItemRelatedItem -> Int #
type AWSResponse AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem type AWSResponse AssociateOpsItemRelatedItem = AssociateOpsItemRelatedItemResponse
type Rep AssociateOpsItemRelatedItem Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem type Rep AssociateOpsItemRelatedItem = D1 ('MetaData "AssociateOpsItemRelatedItem" "Amazonka.SSM.AssociateOpsItemRelatedItem" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "AssociateOpsItemRelatedItem'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "opsItemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "associationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAssociateOpsItemRelatedItem Source #

Arguments

:: Text	`AssociateOpsItemRelatedItem`
-> Text	`AssociateOpsItemRelatedItem`
-> Text	`AssociateOpsItemRelatedItem`
-> Text	`AssociateOpsItemRelatedItem`
-> AssociateOpsItemRelatedItem

Create a value of AssociateOpsItemRelatedItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

AssociateOpsItemRelatedItem, associateOpsItemRelatedItem_resourceType - 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.

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

Request Lenses

associateOpsItemRelatedItem_opsItemId :: Lens' AssociateOpsItemRelatedItem Text Source #

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

associateOpsItemRelatedItem_associationType :: Lens' AssociateOpsItemRelatedItem Text Source #

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

associateOpsItemRelatedItem_resourceType :: Lens' AssociateOpsItemRelatedItem Text Source #

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.

associateOpsItemRelatedItem_resourceUri :: Lens' AssociateOpsItemRelatedItem Text Source #

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

Destructuring the Response

data AssociateOpsItemRelatedItemResponse Source #

See: newAssociateOpsItemRelatedItemResponse smart constructor.

Constructors

AssociateOpsItemRelatedItemResponse'
Fields associationId :: Maybe Text The association ID. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AssociateOpsItemRelatedItemResponse Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Associated Types type Rep AssociateOpsItemRelatedItemResponse :: Type -> Type # Methods from :: AssociateOpsItemRelatedItemResponse -> Rep AssociateOpsItemRelatedItemResponse x # to :: Rep AssociateOpsItemRelatedItemResponse x -> AssociateOpsItemRelatedItemResponse #
Read AssociateOpsItemRelatedItemResponse Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods readsPrec :: Int -> ReadS AssociateOpsItemRelatedItemResponse # readList :: ReadS [AssociateOpsItemRelatedItemResponse] # readPrec :: ReadPrec AssociateOpsItemRelatedItemResponse # readListPrec :: ReadPrec [AssociateOpsItemRelatedItemResponse] #
Show AssociateOpsItemRelatedItemResponse Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods showsPrec :: Int -> AssociateOpsItemRelatedItemResponse -> ShowS # show :: AssociateOpsItemRelatedItemResponse -> String # showList :: [AssociateOpsItemRelatedItemResponse] -> ShowS #
NFData AssociateOpsItemRelatedItemResponse Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods rnf :: AssociateOpsItemRelatedItemResponse -> () #
Eq AssociateOpsItemRelatedItemResponse Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem Methods (==) :: AssociateOpsItemRelatedItemResponse -> AssociateOpsItemRelatedItemResponse -> Bool # (/=) :: AssociateOpsItemRelatedItemResponse -> AssociateOpsItemRelatedItemResponse -> Bool #
type Rep AssociateOpsItemRelatedItemResponse Source #
Instance details Defined in Amazonka.SSM.AssociateOpsItemRelatedItem type Rep AssociateOpsItemRelatedItemResponse = D1 ('MetaData "AssociateOpsItemRelatedItemResponse" "Amazonka.SSM.AssociateOpsItemRelatedItem" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "AssociateOpsItemRelatedItemResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "associationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAssociateOpsItemRelatedItemResponse Source #

Arguments

:: Int	`$sel:httpStatus:AssociateOpsItemRelatedItemResponse'`
-> AssociateOpsItemRelatedItemResponse

Create a value of AssociateOpsItemRelatedItemResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateOpsItemRelatedItemResponse, associateOpsItemRelatedItemResponse_associationId - The association ID.

$sel:httpStatus:AssociateOpsItemRelatedItemResponse', associateOpsItemRelatedItemResponse_httpStatus - The response's http status code.

Response Lenses

associateOpsItemRelatedItemResponse_associationId :: Lens' AssociateOpsItemRelatedItemResponse (Maybe Text) Source #

The association ID.

associateOpsItemRelatedItemResponse_httpStatus :: Lens' AssociateOpsItemRelatedItemResponse Int Source #

The response's http status code.