| 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
Description
Derived from API version 2022-06-10 of the AWS service descriptions, licensed under Apache 2.0.
Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, and traces in any of the linked accounts without account boundaries.
<p>Set up one or more Amazon Web Services accounts as <i>monitoring accounts</i> and link them with multiple <i>source accounts</i>. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, and traces in X-Ray.</p>
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServiceFault :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _MissingRequiredParameterException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateLink = CreateLink' (Maybe (HashMap Text Text)) Text (NonEmpty ResourceType) Text
- newCreateLink :: Text -> NonEmpty ResourceType -> Text -> CreateLink
- data CreateLinkResponse = CreateLinkResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newCreateLinkResponse :: Int -> CreateLinkResponse
- data CreateSink = CreateSink' (Maybe (HashMap Text Text)) Text
- newCreateSink :: Text -> CreateSink
- data CreateSinkResponse = CreateSinkResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newCreateSinkResponse :: Int -> CreateSinkResponse
- data DeleteLink = DeleteLink' Text
- newDeleteLink :: Text -> DeleteLink
- data DeleteLinkResponse = DeleteLinkResponse' Int
- newDeleteLinkResponse :: Int -> DeleteLinkResponse
- data DeleteSink = DeleteSink' Text
- newDeleteSink :: Text -> DeleteSink
- data DeleteSinkResponse = DeleteSinkResponse' Int
- newDeleteSinkResponse :: Int -> DeleteSinkResponse
- data GetLink = GetLink' Text
- newGetLink :: Text -> GetLink
- data GetLinkResponse = GetLinkResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newGetLinkResponse :: Int -> GetLinkResponse
- data GetSink = GetSink' Text
- newGetSink :: Text -> GetSink
- data GetSinkResponse = GetSinkResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newGetSinkResponse :: Int -> GetSinkResponse
- data GetSinkPolicy = GetSinkPolicy' Text
- newGetSinkPolicy :: Text -> GetSinkPolicy
- data GetSinkPolicyResponse = GetSinkPolicyResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetSinkPolicyResponse :: Int -> GetSinkPolicyResponse
- data ListAttachedLinks = ListAttachedLinks' (Maybe Natural) (Maybe Text) Text
- newListAttachedLinks :: Text -> ListAttachedLinks
- data ListAttachedLinksResponse = ListAttachedLinksResponse' (Maybe Text) Int [ListAttachedLinksItem]
- newListAttachedLinksResponse :: Int -> ListAttachedLinksResponse
- data ListLinks = ListLinks' (Maybe Natural) (Maybe Text)
- newListLinks :: ListLinks
- data ListLinksResponse = ListLinksResponse' (Maybe Text) Int [ListLinksItem]
- newListLinksResponse :: Int -> ListLinksResponse
- data ListSinks = ListSinks' (Maybe Natural) (Maybe Text)
- newListSinks :: ListSinks
- data ListSinksResponse = ListSinksResponse' (Maybe Text) Int [ListSinksItem]
- newListSinksResponse :: Int -> ListSinksResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutSinkPolicy = PutSinkPolicy' Text Text
- newPutSinkPolicy :: Text -> Text -> PutSinkPolicy
- data PutSinkPolicyResponse = PutSinkPolicyResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newPutSinkPolicyResponse :: Int -> PutSinkPolicyResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateLink = UpdateLink' Text (NonEmpty ResourceType)
- newUpdateLink :: Text -> NonEmpty ResourceType -> UpdateLink
- data UpdateLinkResponse = UpdateLinkResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newUpdateLinkResponse :: Int -> UpdateLinkResponse
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_AWS__CloudWatch__Metric :: ResourceType
- pattern ResourceType_AWS__Logs__LogGroup :: ResourceType
- pattern ResourceType_AWS__XRay__Trace :: ResourceType
- data ListAttachedLinksItem = ListAttachedLinksItem' (Maybe Text) (Maybe Text) (Maybe [Text])
- newListAttachedLinksItem :: ListAttachedLinksItem
- data ListLinksItem = ListLinksItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text)
- newListLinksItem :: ListLinksItem
- data ListSinksItem = ListSinksItem' (Maybe Text) (Maybe Text) (Maybe Text)
- newListSinksItem :: ListSinksItem
Service Configuration
defaultService :: Service Source #
API version 2022-06-10 of the Amazon CloudWatch Observability Access Manager SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by OAM.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
A resource was in an inconsistent state during an update or a deletion.
InternalServiceFault
_InternalServiceFault :: AsError a => Fold a ServiceError Source #
Unexpected error while processing the request. Retry the request.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
A parameter is specified incorrectly.
MissingRequiredParameterException
_MissingRequiredParameterException :: AsError a => Fold a ServiceError Source #
A required parameter is missing from the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request references a resource that does not exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would cause a service quota to be exceeded.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
A resource can have no more than 50 tags.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The value of a parameter in the request caused an error.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateLink
data CreateLink Source #
See: newCreateLink smart constructor.
Constructors
| CreateLink' (Maybe (HashMap Text Text)) Text (NonEmpty ResourceType) Text |
Instances
Arguments
| :: Text | |
| -> NonEmpty ResourceType | |
| -> Text | |
| -> CreateLink |
Create a value of CreateLink 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:
CreateLink, createLink_tags - Assigns one or more tags (key-value pairs) to the link.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
CreateLink, createLink_labelTemplate - Specify a friendly human-readable name to use to identify this source
account when you are viewing data from it in the monitoring account.
You can use a custom label or use the following variables:
$AccountNameis the name of the account$AccountEmailis the globally unique email address of the account$AccountEmailNoDomainis the email address of the account without the domain name
CreateLink, createLink_resourceTypes - An array of strings that define which types of data that the source
account shares with the monitoring account.
$sel:sinkIdentifier:CreateLink', createLink_sinkIdentifier - The ARN of the sink to use to create this link. You can use
ListSinks
to find the ARNs of sinks.
For more information about sinks, see CreateSink.
data CreateLinkResponse Source #
See: newCreateLinkResponse smart constructor.
Constructors
| CreateLinkResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newCreateLinkResponse Source #
Arguments
| :: Int | |
| -> CreateLinkResponse |
Create a value of CreateLinkResponse 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:
CreateLinkResponse, createLinkResponse_arn - The ARN of the link that is newly created.
CreateLinkResponse, createLinkResponse_id - The random ID string that Amazon Web Services generated as part of the
link ARN.
CreateLinkResponse, createLinkResponse_label - The label that you assigned to this link. If the labelTemplate
includes variables, this field displays the variables resolved to their
actual values.
CreateLink, createLinkResponse_labelTemplate - The exact label template that you specified, with the variables not
resolved.
CreateLink, createLinkResponse_resourceTypes - The resource types supported by this link.
CreateLinkResponse, createLinkResponse_sinkArn - The ARN of the sink that is used for this link.
CreateLink, createLinkResponse_tags - The tags assigned to the link.
$sel:httpStatus:CreateLinkResponse', createLinkResponse_httpStatus - The response's http status code.
CreateSink
data CreateSink Source #
See: newCreateSink smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateSink |
Create a value of CreateSink 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:
CreateSink, createSink_tags - Assigns one or more tags (key-value pairs) to the link.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
CreateSink, createSink_name - A name for the sink.
data CreateSinkResponse Source #
See: newCreateSinkResponse smart constructor.
Constructors
| CreateSinkResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newCreateSinkResponse Source #
Arguments
| :: Int | |
| -> CreateSinkResponse |
Create a value of CreateSinkResponse 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:
CreateSinkResponse, createSinkResponse_arn - The ARN of the sink that is newly created.
CreateSinkResponse, createSinkResponse_id - The random ID string that Amazon Web Services generated as part of the
sink ARN.
CreateSink, createSinkResponse_name - The name of the sink.
CreateSink, createSinkResponse_tags - The tags assigned to the sink.
$sel:httpStatus:CreateSinkResponse', createSinkResponse_httpStatus - The response's http status code.
DeleteLink
data DeleteLink Source #
See: newDeleteLink smart constructor.
Constructors
| DeleteLink' Text |
Instances
Arguments
| :: Text | |
| -> DeleteLink |
Create a value of DeleteLink 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:DeleteLink', deleteLink_identifier - The ARN of the link to delete.
data DeleteLinkResponse Source #
See: newDeleteLinkResponse smart constructor.
Constructors
| DeleteLinkResponse' Int |
Instances
newDeleteLinkResponse Source #
Arguments
| :: Int | |
| -> DeleteLinkResponse |
Create a value of DeleteLinkResponse 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:httpStatus:DeleteLinkResponse', deleteLinkResponse_httpStatus - The response's http status code.
DeleteSink
data DeleteSink Source #
See: newDeleteSink smart constructor.
Constructors
| DeleteSink' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSink |
Create a value of DeleteSink 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:DeleteSink', deleteSink_identifier - The ARN of the sink to delete.
data DeleteSinkResponse Source #
See: newDeleteSinkResponse smart constructor.
Constructors
| DeleteSinkResponse' Int |
Instances
newDeleteSinkResponse Source #
Arguments
| :: Int | |
| -> DeleteSinkResponse |
Create a value of DeleteSinkResponse 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:httpStatus:DeleteSinkResponse', deleteSinkResponse_httpStatus - The response's http status code.
GetLink
See: newGetLink smart constructor.
Instances
| ToJSON GetLink Source # | |
Defined in Amazonka.OAM.GetLink | |
| ToHeaders GetLink Source # | |
Defined in Amazonka.OAM.GetLink | |
| ToPath GetLink Source # | |
Defined in Amazonka.OAM.GetLink Methods toPath :: GetLink -> ByteString # | |
| ToQuery GetLink Source # | |
Defined in Amazonka.OAM.GetLink Methods toQuery :: GetLink -> QueryString # | |
| AWSRequest GetLink Source # | |
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 # | |
| Read GetLink Source # | |
| Show GetLink Source # | |
| NFData GetLink Source # | |
Defined in Amazonka.OAM.GetLink | |
| Eq GetLink Source # | |
| Hashable GetLink Source # | |
Defined in Amazonka.OAM.GetLink | |
| type AWSResponse GetLink Source # | |
Defined in Amazonka.OAM.GetLink | |
| type Rep GetLink Source # | |
Defined in Amazonka.OAM.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.
data GetLinkResponse Source #
See: newGetLinkResponse smart constructor.
Constructors
| GetLinkResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
Arguments
| :: Int | |
| -> 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.
GetSink
See: newGetSink smart constructor.
Instances
| ToJSON GetSink Source # | |
Defined in Amazonka.OAM.GetSink | |
| ToHeaders GetSink Source # | |
Defined in Amazonka.OAM.GetSink | |
| ToPath GetSink Source # | |
Defined in Amazonka.OAM.GetSink Methods toPath :: GetSink -> ByteString # | |
| ToQuery GetSink Source # | |
Defined in Amazonka.OAM.GetSink Methods toQuery :: GetSink -> QueryString # | |
| AWSRequest GetSink Source # | |
Defined in Amazonka.OAM.GetSink Associated Types type AWSResponse GetSink # Methods request :: (Service -> Service) -> GetSink -> Request GetSink # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSink -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSink))) # | |
| Generic GetSink Source # | |
| Read GetSink Source # | |
| Show GetSink Source # | |
| NFData GetSink Source # | |
Defined in Amazonka.OAM.GetSink | |
| Eq GetSink Source # | |
| Hashable GetSink Source # | |
Defined in Amazonka.OAM.GetSink | |
| type AWSResponse GetSink Source # | |
Defined in Amazonka.OAM.GetSink | |
| type Rep GetSink Source # | |
Defined in Amazonka.OAM.GetSink | |
Create a value of GetSink 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:GetSink', getSink_identifier - The ARN of the sink to retrieve information for.
data GetSinkResponse Source #
See: newGetSinkResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> GetSinkResponse |
Create a value of GetSinkResponse 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:
GetSinkResponse, getSinkResponse_arn - The ARN of the sink.
GetSinkResponse, getSinkResponse_id - The random ID string that Amazon Web Services generated as part of the
sink ARN.
GetSinkResponse, getSinkResponse_name - The name of the sink.
$sel:tags:GetSinkResponse', getSinkResponse_tags - The tags assigned to the sink.
$sel:httpStatus:GetSinkResponse', getSinkResponse_httpStatus - The response's http status code.
GetSinkPolicy
data GetSinkPolicy Source #
See: newGetSinkPolicy smart constructor.
Constructors
| GetSinkPolicy' Text |
Instances
Arguments
| :: Text | |
| -> GetSinkPolicy |
Create a value of GetSinkPolicy 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:sinkIdentifier:GetSinkPolicy', getSinkPolicy_sinkIdentifier - The ARN of the sink to retrieve the policy of.
data GetSinkPolicyResponse Source #
See: newGetSinkPolicyResponse smart constructor.
Instances
newGetSinkPolicyResponse Source #
Create a value of GetSinkPolicyResponse 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:policy:GetSinkPolicyResponse', getSinkPolicyResponse_policy - The policy that you specified, in JSON format.
GetSinkPolicyResponse, getSinkPolicyResponse_sinkArn - The ARN of the sink.
$sel:sinkId:GetSinkPolicyResponse', getSinkPolicyResponse_sinkId - The random ID string that Amazon Web Services generated as part of the
sink ARN.
$sel:httpStatus:GetSinkPolicyResponse', getSinkPolicyResponse_httpStatus - The response's http status code.
ListAttachedLinks (Paginated)
data ListAttachedLinks Source #
See: newListAttachedLinks smart constructor.
Instances
Arguments
| :: Text | |
| -> ListAttachedLinks |
Create a value of ListAttachedLinks 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:maxResults:ListAttachedLinks', listAttachedLinks_maxResults - Limits the number of returned links to the specified number.
ListAttachedLinks, listAttachedLinks_nextToken - The token for the next set of items to return. You received this token
from a previous call.
$sel:sinkIdentifier:ListAttachedLinks', listAttachedLinks_sinkIdentifier - The ARN of the sink that you want to retrieve links for.
data ListAttachedLinksResponse Source #
See: newListAttachedLinksResponse smart constructor.
Constructors
| ListAttachedLinksResponse' (Maybe Text) Int [ListAttachedLinksItem] |
Instances
newListAttachedLinksResponse Source #
Create a value of ListAttachedLinksResponse 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:
ListAttachedLinks, listAttachedLinksResponse_nextToken - The token to use when requesting the next set of links.
$sel:httpStatus:ListAttachedLinksResponse', listAttachedLinksResponse_httpStatus - The response's http status code.
$sel:items:ListAttachedLinksResponse', listAttachedLinksResponse_items - An array of structures that contain the information about the attached
links.
ListLinks (Paginated)
See: newListLinks smart constructor.
Constructors
| ListLinks' (Maybe Natural) (Maybe Text) |
Instances
newListLinks :: ListLinks Source #
Create a value of ListLinks 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:maxResults:ListLinks', listLinks_maxResults - Limits the number of returned links to the specified number.
ListLinks, listLinks_nextToken - The token for the next set of items to return. You received this token
from a previous call.
data ListLinksResponse Source #
See: newListLinksResponse smart constructor.
Constructors
| ListLinksResponse' (Maybe Text) Int [ListLinksItem] |
Instances
Arguments
| :: Int | |
| -> ListLinksResponse |
Create a value of ListLinksResponse 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:
ListLinks, listLinksResponse_nextToken - The token to use when requesting the next set of links.
$sel:httpStatus:ListLinksResponse', listLinksResponse_httpStatus - The response's http status code.
$sel:items:ListLinksResponse', listLinksResponse_items - An array of structures that contain the information about the returned
links.
ListSinks (Paginated)
See: newListSinks smart constructor.
Constructors
| ListSinks' (Maybe Natural) (Maybe Text) |
Instances
newListSinks :: ListSinks Source #
Create a value of ListSinks 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:maxResults:ListSinks', listSinks_maxResults - Limits the number of returned links to the specified number.
ListSinks, listSinks_nextToken - The token for the next set of items to return. You received this token
from a previous call.
data ListSinksResponse Source #
See: newListSinksResponse smart constructor.
Constructors
| ListSinksResponse' (Maybe Text) Int [ListSinksItem] |
Instances
Arguments
| :: Int | |
| -> ListSinksResponse |
Create a value of ListSinksResponse 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:
ListSinks, listSinksResponse_nextToken - The token to use when requesting the next set of sinks.
$sel:httpStatus:ListSinksResponse', listSinksResponse_httpStatus - The response's http status code.
$sel:items:ListSinksResponse', listSinksResponse_items - An array of structures that contain the information about the returned
sinks.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The ARN of the resource that you want to view tags for.
The ARN format of a sink is
arn:aws:oam:Region:account-id:sink/sink-id
The ARN format of a link is
arn:aws:oam:Region:account-id:link/link-id
For more information about ARN format, see CloudWatch Logs resources and operations.
Unlike tagging permissions in other Amazon Web Services services, to
retrieve the list of tags for links or sinks you must have the
oam:RequestTag permission. The aws:ReguestTag permission does not
allow you to tag and untag links and sinks.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The list of tags associated with the requested resource.>
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
PutSinkPolicy
data PutSinkPolicy Source #
See: newPutSinkPolicy smart constructor.
Constructors
| PutSinkPolicy' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PutSinkPolicy |
Create a value of PutSinkPolicy 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:sinkIdentifier:PutSinkPolicy', putSinkPolicy_sinkIdentifier - The ARN of the sink to attach this policy to.
PutSinkPolicy, putSinkPolicy_policy - The JSON policy to use. If you are updating an existing policy, the
entire existing policy is replaced by what you specify here.
The policy must be in JSON string format with quotation marks escaped and no newlines.
For examples of different types of policies, see the Examples section on this page.
data PutSinkPolicyResponse Source #
See: newPutSinkPolicyResponse smart constructor.
Instances
newPutSinkPolicyResponse Source #
Create a value of PutSinkPolicyResponse 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:
PutSinkPolicy, putSinkPolicyResponse_policy - The policy that you specified.
PutSinkPolicyResponse, putSinkPolicyResponse_sinkArn - The ARN of the sink.
$sel:sinkId:PutSinkPolicyResponse', putSinkPolicyResponse_sinkId - The random ID string that Amazon Web Services generated as part of the
sink ARN.
$sel:httpStatus:PutSinkPolicyResponse', putSinkPolicyResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The ARN of the resource that you're adding tags to.
The ARN format of a sink is
arn:aws:oam:Region:account-id:sink/sink-id
The ARN format of a link is
arn:aws:oam:Region:account-id:link/link-id
For more information about ARN format, see CloudWatch Logs resources and operations.
$sel:tags:TagResource', tagResource_tags - The list of key-value pairs to associate with the resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the resource that you're removing tags from.
The ARN format of a sink is
arn:aws:oam:Region:account-id:sink/sink-id
The ARN format of a link is
arn:aws:oam:Region:account-id:link/link-id
For more information about ARN format, see CloudWatch Logs resources and operations.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The list of tag keys to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateLink
data UpdateLink Source #
See: newUpdateLink smart constructor.
Constructors
| UpdateLink' Text (NonEmpty ResourceType) |
Instances
Arguments
| :: Text | |
| -> NonEmpty ResourceType | |
| -> UpdateLink |
Create a value of UpdateLink 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:UpdateLink', updateLink_identifier - The ARN of the link that you want to update.
UpdateLink, updateLink_resourceTypes - An array of strings that define which types of data that the source
account will send to the monitoring account.
Your input here replaces the current set of data types that are shared.
data UpdateLinkResponse Source #
See: newUpdateLinkResponse smart constructor.
Constructors
| UpdateLinkResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newUpdateLinkResponse Source #
Arguments
| :: Int | |
| -> UpdateLinkResponse |
Create a value of UpdateLinkResponse 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:
UpdateLinkResponse, updateLinkResponse_arn - The ARN of the link that you have updated.
UpdateLinkResponse, updateLinkResponse_id - The random ID string that Amazon Web Services generated as part of the
sink ARN.
UpdateLinkResponse, updateLinkResponse_label - The label assigned to this link, with the variables resolved to their
actual values.
$sel:labelTemplate:UpdateLinkResponse', updateLinkResponse_labelTemplate - The exact label template that was specified when the link was created,
with the template variables not resolved.
UpdateLink, updateLinkResponse_resourceTypes - The resource types now supported by this link.
UpdateLinkResponse, updateLinkResponse_sinkArn - The ARN of the sink that is used for this link.
$sel:tags:UpdateLinkResponse', updateLinkResponse_tags - The tags assigned to the link.
$sel:httpStatus:UpdateLinkResponse', updateLinkResponse_httpStatus - The response's http status code.
Types
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_AWS__CloudWatch__Metric :: ResourceType | |
| pattern ResourceType_AWS__Logs__LogGroup :: ResourceType | |
| pattern ResourceType_AWS__XRay__Trace :: ResourceType |
Instances
ListAttachedLinksItem
data ListAttachedLinksItem Source #
A structure that contains information about one link attached to this monitoring account sink.
See: newListAttachedLinksItem smart constructor.
Instances
newListAttachedLinksItem :: ListAttachedLinksItem Source #
Create a value of ListAttachedLinksItem 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:label:ListAttachedLinksItem', listAttachedLinksItem_label - The label that was assigned to this link at creation, with the variables
resolved to their actual values.
$sel:linkArn:ListAttachedLinksItem', listAttachedLinksItem_linkArn - The ARN of the link.
$sel:resourceTypes:ListAttachedLinksItem', listAttachedLinksItem_resourceTypes - The resource types supported by this link.
ListLinksItem
data ListLinksItem Source #
A structure that contains information about one of this source account's links to a monitoring account.
See: newListLinksItem smart constructor.
Instances
newListLinksItem :: ListLinksItem Source #
Create a value of ListLinksItem 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:arn:ListLinksItem', listLinksItem_arn - The ARN of the link.
$sel:id:ListLinksItem', listLinksItem_id - The random ID string that Amazon Web Services generated as part of the
link ARN.
$sel:label:ListLinksItem', listLinksItem_label - The label that was assigned to this link at creation, with the variables
resolved to their actual values.
$sel:resourceTypes:ListLinksItem', listLinksItem_resourceTypes - The resource types supported by this link.
$sel:sinkArn:ListLinksItem', listLinksItem_sinkArn - The ARN of the sink that this link is attached to.
ListSinksItem
data ListSinksItem Source #
A structure that contains information about one of this monitoring account's sinks.
See: newListSinksItem smart constructor.
Instances
newListSinksItem :: ListSinksItem Source #
Create a value of ListSinksItem 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:arn:ListSinksItem', listSinksItem_arn - The ARN of the sink.
$sel:id:ListSinksItem', listSinksItem_id - The random ID string that Amazon Web Services generated as part of the
sink ARN.
$sel:name:ListSinksItem', listSinksItem_name - The name of the sink.