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.OAM.GetLink

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns complete information about one link.

To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.

Synopsis

data GetLink = GetLink' {
- identifier :: Text
}
newGetLink :: Text -> GetLink
getLink_identifier :: Lens' GetLink Text
data GetLinkResponse = GetLinkResponse' {
- arn :: Maybe Text
- id :: Maybe Text
- label :: Maybe Text
- labelTemplate :: Maybe Text
- resourceTypes :: Maybe [Text]
- sinkArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newGetLinkResponse :: Int -> GetLinkResponse
getLinkResponse_arn :: Lens' GetLinkResponse (Maybe Text)
getLinkResponse_id :: Lens' GetLinkResponse (Maybe Text)
getLinkResponse_label :: Lens' GetLinkResponse (Maybe Text)
getLinkResponse_labelTemplate :: Lens' GetLinkResponse (Maybe Text)
getLinkResponse_resourceTypes :: Lens' GetLinkResponse (Maybe [Text])
getLinkResponse_sinkArn :: Lens' GetLinkResponse (Maybe Text)
getLinkResponse_tags :: Lens' GetLinkResponse (Maybe (HashMap Text Text))
getLinkResponse_httpStatus :: Lens' GetLinkResponse Int

Creating a Request

data GetLink Source #

See: newGetLink smart constructor.

Constructors

GetLink'
Fields identifier :: Text The ARN of the link to retrieve information for.

Instances

Instances details

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

newGetLink Source #

Arguments

:: Text	`$sel:identifier:GetLink'`
-> GetLink

Create a value of GetLink 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:

$sel:identifier:GetLink', getLink_identifier - The ARN of the link to retrieve information for.

Request Lenses

getLink_identifier :: Lens' GetLink Text Source #

The ARN of the link to retrieve information for.

Destructuring the Response

data GetLinkResponse Source #

See: newGetLinkResponse smart constructor.

Constructors

GetLinkResponse'

Fields

arn :: Maybe Text
The ARN of the link.
id :: Maybe Text
The random ID string that Amazon Web Services generated as part of the link ARN.
label :: Maybe Text
The label that you assigned to this link, with the variables resolved to their actual values.
labelTemplate :: Maybe Text
The exact label template that was specified when the link was created, with the template variables not resolved.
resourceTypes :: Maybe [Text]
The resource types supported by this link.
sinkArn :: Maybe Text
The ARN of the sink that is used for this link.
tags :: Maybe (HashMap Text Text)
The tags assigned to the link.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetLinkResponse Source #
Instance details Defined in Amazonka.OAM.GetLink Associated Types type Rep GetLinkResponse :: Type -> Type # Methods from :: GetLinkResponse -> Rep GetLinkResponse x # to :: Rep GetLinkResponse x -> GetLinkResponse #
Read GetLinkResponse Source #
Instance details Defined in Amazonka.OAM.GetLink Methods readsPrec :: Int -> ReadS GetLinkResponse # readList :: ReadS [GetLinkResponse] # readPrec :: ReadPrec GetLinkResponse # readListPrec :: ReadPrec [GetLinkResponse] #
Show GetLinkResponse Source #
Instance details Defined in Amazonka.OAM.GetLink Methods showsPrec :: Int -> GetLinkResponse -> ShowS # show :: GetLinkResponse -> String # showList :: [GetLinkResponse] -> ShowS #
NFData GetLinkResponse Source #
Instance details Defined in Amazonka.OAM.GetLink Methods rnf :: GetLinkResponse -> () #
Eq GetLinkResponse Source #
Instance details Defined in Amazonka.OAM.GetLink Methods (==) :: GetLinkResponse -> GetLinkResponse -> Bool # (/=) :: GetLinkResponse -> GetLinkResponse -> Bool #
type Rep GetLinkResponse Source #
Instance details Defined in Amazonka.OAM.GetLink type Rep GetLinkResponse = D1 ('MetaData "GetLinkResponse" "Amazonka.OAM.GetLink" "amazonka-oam-2.0-2r3dTellrOe218sRY2Qi5h" 'False) (C1 ('MetaCons "GetLinkResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "labelTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "sinkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetLinkResponse Source #

Arguments

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

Create a value of GetLinkResponse 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:

GetLinkResponse, getLinkResponse_arn - The ARN of the link.

GetLinkResponse, getLinkResponse_id - The random ID string that Amazon Web Services generated as part of the link ARN.

GetLinkResponse, getLinkResponse_label - The label that you assigned to this link, with the variables resolved to their actual values.

$sel:labelTemplate:GetLinkResponse', getLinkResponse_labelTemplate - The exact label template that was specified when the link was created, with the template variables not resolved.

GetLinkResponse, getLinkResponse_resourceTypes - The resource types supported by this link.

GetLinkResponse, getLinkResponse_sinkArn - The ARN of the sink that is used for this link.

$sel:tags:GetLinkResponse', getLinkResponse_tags - The tags assigned to the link.

$sel:httpStatus:GetLinkResponse', getLinkResponse_httpStatus - The response's http status code.

Response Lenses

getLinkResponse_arn :: Lens' GetLinkResponse (Maybe Text) Source #

The ARN of the link.

getLinkResponse_id :: Lens' GetLinkResponse (Maybe Text) Source #

The random ID string that Amazon Web Services generated as part of the link ARN.

getLinkResponse_label :: Lens' GetLinkResponse (Maybe Text) Source #

The label that you assigned to this link, with the variables resolved to their actual values.

getLinkResponse_labelTemplate :: Lens' GetLinkResponse (Maybe Text) Source #

The exact label template that was specified when the link was created, with the template variables not resolved.

getLinkResponse_resourceTypes :: Lens' GetLinkResponse (Maybe [Text]) Source #

The resource types supported by this link.

getLinkResponse_sinkArn :: Lens' GetLinkResponse (Maybe Text) Source #

The ARN of the sink that is used for this link.

getLinkResponse_tags :: Lens' GetLinkResponse (Maybe (HashMap Text Text)) Source #

The tags assigned to the link.

getLinkResponse_httpStatus :: Lens' GetLinkResponse Int Source #

The response's http status code.