Class: Aws::AIOps::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AIOps::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb
Overview
An API client for AIOps. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::AIOps::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_investigation_group(params = {}) ⇒ Types::CreateInvestigationGroupOutput
Creates an investigation group in your account.
-
#delete_investigation_group(params = {}) ⇒ Struct
Deletes the specified investigation group from your account.
-
#delete_investigation_group_policy(params = {}) ⇒ Struct
Removes the IAM resource policy from being associated with the investigation group that you specify.
-
#get_investigation_group(params = {}) ⇒ Types::GetInvestigationGroupResponse
Returns the configuration information for the specified investigation group.
-
#get_investigation_group_policy(params = {}) ⇒ Types::GetInvestigationGroupPolicyResponse
Returns the JSON of the IAM resource policy associated with the specified investigation group in a string.
-
#list_investigation_groups(params = {}) ⇒ Types::ListInvestigationGroupsOutput
Returns the ARN and name of each investigation group in the account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Displays the tags associated with a CloudWatch investigations resource.
-
#put_investigation_group_policy(params = {}) ⇒ Types::PutInvestigationGroupPolicyResponse
Creates an IAM resource policy and assigns it to the specified investigation group.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
-
#update_investigation_group(params = {}) ⇒ Struct
Updates the configuration of the specified investigation group.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#create_investigation_group(params = {}) ⇒ Types::CreateInvestigationGroupOutput
Creates an investigation group in your account. Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.
Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:
Who can access the investigations
Whether investigation data is encrypted with a customer managed Key Management Service key.
How long investigations and their data are retained by default.
Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region
To create an investigation group and set up CloudWatch investigations,
you must be signed in to an IAM principal that has either the
AIOpsConsoleAdminPolicy
or the AdministratorAccess
IAM policy
attached, or to an account that has similar permissions.
You can configure CloudWatch alarms to start investigations and add
events to investigations. If you create your investigation group with
CreateInvestigationGroup
and you want to enable alarms to do this,
you must use PutInvestigationGroupPolicy
to create a resource policy
that grants this permission to CloudWatch alarms.
For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms
638 639 640 641 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 638 def create_investigation_group(params = {}, = {}) req = build_request(:create_investigation_group, params) req.send_request() end |
#delete_investigation_group(params = {}) ⇒ Struct
Deletes the specified investigation group from your account. You can currently have one investigation group per Region in your account. After you delete an investigation group, you can later create a new investigation group in the same Region.
664 665 666 667 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 664 def delete_investigation_group(params = {}, = {}) req = build_request(:delete_investigation_group, params) req.send_request() end |
#delete_investigation_group_policy(params = {}) ⇒ Struct
Removes the IAM resource policy from being associated with the investigation group that you specify.
688 689 690 691 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 688 def delete_investigation_group_policy(params = {}, = {}) req = build_request(:delete_investigation_group_policy, params) req.send_request() end |
#get_investigation_group(params = {}) ⇒ Types::GetInvestigationGroupResponse
Returns the configuration information for the specified investigation group.
747 748 749 750 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 747 def get_investigation_group(params = {}, = {}) req = build_request(:get_investigation_group, params) req.send_request() end |
#get_investigation_group_policy(params = {}) ⇒ Types::GetInvestigationGroupPolicyResponse
Returns the JSON of the IAM resource policy associated with the
specified investigation group in a string. For example,
{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"Service":"aiops.alarms.cloudwatch.amazonaws.com"},"Action":["aiops:CreateInvestigation","aiops:CreateInvestigationEvent"],"Resource":"*","Condition":{"StringEquals":{"aws:SourceAccount":"111122223333"},"ArnLike":{"aws:SourceArn":"arn:aws:cloudwatch:us-east-1:111122223333:alarm:*"}}}]}
.
780 781 782 783 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 780 def get_investigation_group_policy(params = {}, = {}) req = build_request(:get_investigation_group_policy, params) req.send_request() end |
#list_investigation_groups(params = {}) ⇒ Types::ListInvestigationGroupsOutput
Returns the ARN and name of each investigation group in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
820 821 822 823 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 820 def list_investigation_groups(params = {}, = {}) req = build_request(:list_investigation_groups, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Displays the tags associated with a CloudWatch investigations resource. Currently, investigation groups support tagging.
856 857 858 859 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 856 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_investigation_group_policy(params = {}) ⇒ Types::PutInvestigationGroupPolicyResponse
Creates an IAM resource policy and assigns it to the specified investigation group.
If you create your investigation group with CreateInvestigationGroup
and you want to enable CloudWatch alarms to create investigations and
add events to investigations, you must use this operation to create a
policy similar to this example.
{ "Version": "2008-10-17", "Statement": [ { "Effect": "Allow",
"Principal": { "Service": "aiops.alarms.cloudwatch.amazonaws.com" },
"Action": [ "aiops:CreateInvestigation",
"aiops:CreateInvestigationEvent" ], "Resource": "*", "Condition": {
"StringEquals": { "aws:SourceAccount": "account-id" }, "ArnLike": {
"aws:SourceArn": "arn:aws:cloudwatch:region:account-id:alarm:*" } } }
] }
903 904 905 906 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 903 def put_investigation_group_policy(params = {}, = {}) req = build_request(:put_investigation_group_policy, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified resource.
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.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a resource.
942 943 944 945 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 942 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified resource.
970 971 972 973 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 970 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_investigation_group(params = {}) ⇒ Struct
Updates the configuration of the specified investigation group.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/client.rb', line 1073 def update_investigation_group(params = {}, = {}) req = build_request(:update_investigation_group, params) req.send_request() end |