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.Lens

Contents

Operations
Types

Description

Synopsis

Operations

CreateLink

createLink_tags :: Lens' CreateLink (Maybe (HashMap Text Text)) Source #

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_labelTemplate :: Lens' CreateLink Text Source #

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:

$AccountName is the name of the account
$AccountEmail is the globally unique email address of the account
$AccountEmailNoDomain is the email address of the account without the domain name

createLink_resourceTypes :: Lens' CreateLink (NonEmpty ResourceType) Source #

An array of strings that define which types of data that the source account shares with the monitoring account.

createLink_sinkIdentifier :: Lens' CreateLink Text Source #

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.

createLinkResponse_arn :: Lens' CreateLinkResponse (Maybe Text) Source #

The ARN of the link that is newly created.

createLinkResponse_id :: Lens' CreateLinkResponse (Maybe Text) Source #

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

createLinkResponse_label :: Lens' CreateLinkResponse (Maybe Text) Source #

The label that you assigned to this link. If the labelTemplate includes variables, this field displays the variables resolved to their actual values.

createLinkResponse_labelTemplate :: Lens' CreateLinkResponse (Maybe Text) Source #

The exact label template that you specified, with the variables not resolved.

createLinkResponse_resourceTypes :: Lens' CreateLinkResponse (Maybe [Text]) Source #

The resource types supported by this link.

createLinkResponse_sinkArn :: Lens' CreateLinkResponse (Maybe Text) Source #

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

createLinkResponse_tags :: Lens' CreateLinkResponse (Maybe (HashMap Text Text)) Source #

The tags assigned to the link.

createLinkResponse_httpStatus :: Lens' CreateLinkResponse Int Source #

The response's http status code.

CreateSink

createSink_tags :: Lens' CreateSink (Maybe (HashMap Text Text)) Source #

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_name :: Lens' CreateSink Text Source #

A name for the sink.

createSinkResponse_arn :: Lens' CreateSinkResponse (Maybe Text) Source #

The ARN of the sink that is newly created.

createSinkResponse_id :: Lens' CreateSinkResponse (Maybe Text) Source #

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

createSinkResponse_name :: Lens' CreateSinkResponse (Maybe Text) Source #

The name of the sink.

createSinkResponse_tags :: Lens' CreateSinkResponse (Maybe (HashMap Text Text)) Source #

The tags assigned to the sink.

createSinkResponse_httpStatus :: Lens' CreateSinkResponse Int Source #

The response's http status code.

DeleteLink

deleteLink_identifier :: Lens' DeleteLink Text Source #

The ARN of the link to delete.

deleteLinkResponse_httpStatus :: Lens' DeleteLinkResponse Int Source #

The response's http status code.

DeleteSink

deleteSink_identifier :: Lens' DeleteSink Text Source #

The ARN of the sink to delete.

deleteSinkResponse_httpStatus :: Lens' DeleteSinkResponse Int Source #

The response's http status code.

GetLink

getLink_identifier :: Lens' GetLink Text Source #

The ARN of the link to retrieve information for.

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.

GetSink

getSink_identifier :: Lens' GetSink Text Source #

The ARN of the sink to retrieve information for.

getSinkResponse_arn :: Lens' GetSinkResponse (Maybe Text) Source #

The ARN of the sink.

getSinkResponse_id :: Lens' GetSinkResponse (Maybe Text) Source #

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

getSinkResponse_name :: Lens' GetSinkResponse (Maybe Text) Source #

The name of the sink.

getSinkResponse_tags :: Lens' GetSinkResponse (Maybe (HashMap Text Text)) Source #

The tags assigned to the sink.

getSinkResponse_httpStatus :: Lens' GetSinkResponse Int Source #

The response's http status code.

GetSinkPolicy

getSinkPolicy_sinkIdentifier :: Lens' GetSinkPolicy Text Source #

The ARN of the sink to retrieve the policy of.

getSinkPolicyResponse_policy :: Lens' GetSinkPolicyResponse (Maybe Text) Source #

The policy that you specified, in JSON format.

getSinkPolicyResponse_sinkArn :: Lens' GetSinkPolicyResponse (Maybe Text) Source #

The ARN of the sink.

getSinkPolicyResponse_sinkId :: Lens' GetSinkPolicyResponse (Maybe Text) Source #

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

getSinkPolicyResponse_httpStatus :: Lens' GetSinkPolicyResponse Int Source #

The response's http status code.

ListAttachedLinks

listAttachedLinks_maxResults :: Lens' ListAttachedLinks (Maybe Natural) Source #

Limits the number of returned links to the specified number.

listAttachedLinks_nextToken :: Lens' ListAttachedLinks (Maybe Text) Source #

The token for the next set of items to return. You received this token from a previous call.

listAttachedLinks_sinkIdentifier :: Lens' ListAttachedLinks Text Source #

The ARN of the sink that you want to retrieve links for.

listAttachedLinksResponse_nextToken :: Lens' ListAttachedLinksResponse (Maybe Text) Source #

The token to use when requesting the next set of links.

listAttachedLinksResponse_httpStatus :: Lens' ListAttachedLinksResponse Int Source #

The response's http status code.

listAttachedLinksResponse_items :: Lens' ListAttachedLinksResponse [ListAttachedLinksItem] Source #

An array of structures that contain the information about the attached links.

ListLinks

listLinks_maxResults :: Lens' ListLinks (Maybe Natural) Source #

Limits the number of returned links to the specified number.

listLinks_nextToken :: Lens' ListLinks (Maybe Text) Source #

The token for the next set of items to return. You received this token from a previous call.

listLinksResponse_nextToken :: Lens' ListLinksResponse (Maybe Text) Source #

The token to use when requesting the next set of links.

listLinksResponse_httpStatus :: Lens' ListLinksResponse Int Source #

The response's http status code.

listLinksResponse_items :: Lens' ListLinksResponse [ListLinksItem] Source #

An array of structures that contain the information about the returned links.

ListSinks

listSinks_maxResults :: Lens' ListSinks (Maybe Natural) Source #

Limits the number of returned links to the specified number.

listSinks_nextToken :: Lens' ListSinks (Maybe Text) Source #

The token for the next set of items to return. You received this token from a previous call.

listSinksResponse_nextToken :: Lens' ListSinksResponse (Maybe Text) Source #

The token to use when requesting the next set of sinks.

listSinksResponse_httpStatus :: Lens' ListSinksResponse Int Source #

The response's http status code.

listSinksResponse_items :: Lens' ListSinksResponse [ListSinksItem] Source #

An array of structures that contain the information about the returned sinks.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

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.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The list of tags associated with the requested resource.>

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

PutSinkPolicy

putSinkPolicy_sinkIdentifier :: Lens' PutSinkPolicy Text Source #

The ARN of the sink to attach this policy to.

putSinkPolicy_policy :: Lens' PutSinkPolicy Text Source #

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.

putSinkPolicyResponse_policy :: Lens' PutSinkPolicyResponse (Maybe Text) Source #

The policy that you specified.

putSinkPolicyResponse_sinkArn :: Lens' PutSinkPolicyResponse (Maybe Text) Source #

The ARN of the sink.

putSinkPolicyResponse_sinkId :: Lens' PutSinkPolicyResponse (Maybe Text) Source #

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

putSinkPolicyResponse_httpStatus :: Lens' PutSinkPolicyResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

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.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The list of key-value pairs to associate with the resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

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.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The list of tag keys to remove from the resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateLink

updateLink_identifier :: Lens' UpdateLink Text Source #

The ARN of the link that you want to update.

updateLink_resourceTypes :: Lens' UpdateLink (NonEmpty ResourceType) Source #

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.

updateLinkResponse_arn :: Lens' UpdateLinkResponse (Maybe Text) Source #

The ARN of the link that you have updated.

updateLinkResponse_id :: Lens' UpdateLinkResponse (Maybe Text) Source #

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

updateLinkResponse_label :: Lens' UpdateLinkResponse (Maybe Text) Source #

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

updateLinkResponse_labelTemplate :: Lens' UpdateLinkResponse (Maybe Text) Source #

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

updateLinkResponse_resourceTypes :: Lens' UpdateLinkResponse (Maybe [Text]) Source #

The resource types now supported by this link.

updateLinkResponse_sinkArn :: Lens' UpdateLinkResponse (Maybe Text) Source #

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

updateLinkResponse_tags :: Lens' UpdateLinkResponse (Maybe (HashMap Text Text)) Source #

The tags assigned to the link.

updateLinkResponse_httpStatus :: Lens' UpdateLinkResponse Int Source #

The response's http status code.

Types

ListAttachedLinksItem

listAttachedLinksItem_label :: Lens' ListAttachedLinksItem (Maybe Text) Source #

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

listAttachedLinksItem_linkArn :: Lens' ListAttachedLinksItem (Maybe Text) Source #

The ARN of the link.

listAttachedLinksItem_resourceTypes :: Lens' ListAttachedLinksItem (Maybe [Text]) Source #

The resource types supported by this link.

ListLinksItem

listLinksItem_arn :: Lens' ListLinksItem (Maybe Text) Source #

The ARN of the link.

listLinksItem_id :: Lens' ListLinksItem (Maybe Text) Source #

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

listLinksItem_label :: Lens' ListLinksItem (Maybe Text) Source #

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

listLinksItem_resourceTypes :: Lens' ListLinksItem (Maybe [Text]) Source #

The resource types supported by this link.

listLinksItem_sinkArn :: Lens' ListLinksItem (Maybe Text) Source #

The ARN of the sink that this link is attached to.

ListSinksItem

listSinksItem_arn :: Lens' ListSinksItem (Maybe Text) Source #

The ARN of the sink.

listSinksItem_id :: Lens' ListSinksItem (Maybe Text) Source #

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

listSinksItem_name :: Lens' ListSinksItem (Maybe Text) Source #

The name of the sink.