<?php
// This file was auto-generated from sdk-root/src/data/aiops/2018-05-10/docs-2.json
return [ 'version' => '2.0', 'service' => '<p>The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system\'s telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. </p> <p>You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.</p>', 'operations' => [ 'CreateInvestigationGroup' => '<p>Creates an <i>investigation group</i> 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.</p> <p>Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:</p> <ul> <li> <p>Who can access the investigations</p> </li> <li> <p>Whether investigation data is encrypted with a customer managed Key Management Service key.</p> </li> <li> <p>How long investigations and their data are retained by default.</p> </li> </ul> <p>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</p> <p>To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the <code>AIOpsConsoleAdminPolicy</code> or the <code>AdministratorAccess</code> IAM policy attached, or to an account that has similar permissions.</p> <important> <p>You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with <code>CreateInvestigationGroup</code> and you want to enable alarms to do this, you must use <code>PutInvestigationGroupPolicy</code> to create a resource policy that grants this permission to CloudWatch alarms. </p> <p>For more information about configuring CloudWatch alarms, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html">Using Amazon CloudWatch alarms</a> </p> </important>', 'DeleteInvestigationGroup' => '<p>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.</p>', 'DeleteInvestigationGroupPolicy' => '<p>Removes the IAM resource policy from being associated with the investigation group that you specify.</p>', 'GetInvestigationGroup' => '<p>Returns the configuration information for the specified investigation group.</p>', 'GetInvestigationGroupPolicy' => '<p>Returns the JSON of the IAM resource policy associated with the specified investigation group in a string. For example, <code>{\\"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:*\\"}}}]}</code>.</p>', 'ListInvestigationGroups' => '<p>Returns the ARN and name of each investigation group in the account.</p>', 'ListTagsForResource' => '<p>Displays the tags associated with a CloudWatch investigations resource. Currently, investigation groups support tagging.</p>', 'PutInvestigationGroupPolicy' => '<p>Creates an IAM resource policy and assigns it to the specified investigation group.</p> <p>If you create your investigation group with <code>CreateInvestigationGroup</code> 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.</p> <p> <code> { "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:*" } } } ] } </code> </p>', 'TagResource' => '<p>Assigns one or more tags (key-value pairs) to the specified resource.</p> <p>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.</p> <p>Tags don\'t have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p> <p>You can associate as many as 50 tags with a resource.</p>', 'UntagResource' => '<p>Removes one or more tags from the specified resource.</p>', 'UpdateInvestigationGroup' => '<p>Updates the configuration of the specified investigation group.</p>', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '<p>You don\'t have sufficient permissions to perform this action.</p>', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreateInvestigationGroupInput$isCloudTrailEventHistoryEnabled' => '<p>Specify <code>true</code> to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default is <code>true</code>.</p>', 'GetInvestigationGroupResponse$isCloudTrailEventHistoryEnabled' => '<p>Specifies whether CloudWatch investigationshas access to change events that are recorded by CloudTrail.</p>', 'UpdateInvestigationGroupRequest$isCloudTrailEventHistoryEnabled' => '<p>Specify <code>true</code> to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default is <code>true</code>.</p>', ], ], 'ChatConfigurationArn' => [ 'base' => NULL, 'refs' => [ 'ChatConfigurationArns$member' => NULL, ], ], 'ChatConfigurationArns' => [ 'base' => NULL, 'refs' => [ 'ChatbotNotificationChannel$value' => NULL, ], ], 'ChatbotNotificationChannel' => [ 'base' => NULL, 'refs' => [ 'CreateInvestigationGroupInput$chatbotNotificationChannel' => '<p>Use this structure to integrate CloudWatch investigations with chat applications. This structure is a string array. For the first string, specify the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of one or more chat applications configurations that you want to associate with that topic. For more information about these configuration ARNs, see <a href="https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html">Getting started with Amazon Q in chat applications</a> and <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies">Resource type defined by Amazon Web Services Chatbot</a>.</p>', 'GetInvestigationGroupResponse$chatbotNotificationChannel' => '<p>This structure is a string array. The first string is the ARN of a Amazon SNS topic. The array of strings display the ARNs of chat applications configurations that are associated with that topic. For more information about these configuration ARNs, see <a href="https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html">Getting started with Amazon Q in chat applications</a> and <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies">Resource type defined by Amazon Web Services Chatbot</a>.</p>', 'UpdateInvestigationGroupRequest$chatbotNotificationChannel' => '<p>Use this structure to integrate CloudWatch investigations with chat applications. This structure is a string array. For the first string, specify the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of one or more chat applications configurations that you want to associate with that topic. For more information about these configuration ARNs, see <a href="https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html">Getting started with Amazon Q in chat applications</a> and <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies">Resource type defined by Amazon Web Services Chatbot</a>.</p>', ], ], 'ConflictException' => [ 'base' => '<p>This operation couldn\'t be completed because of a conflict in resource states.</p>', 'refs' => [], ], 'CreateInvestigationGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateInvestigationGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'CrossAccountConfiguration' => [ 'base' => '<p>This structure contains information about the cross-account configuration in the account. </p>', 'refs' => [ 'CrossAccountConfigurations$member' => NULL, ], ], 'CrossAccountConfigurations' => [ 'base' => NULL, 'refs' => [ 'CreateInvestigationGroupInput$crossAccountConfigurations' => '<p>List of <code>sourceRoleArn</code> values that have been configured for cross-account access.</p>', 'GetInvestigationGroupResponse$crossAccountConfigurations' => '<p>Lists the <code>AWSAccountId</code> of the accounts configured for cross-account access and the results of the last scan performed on each account.</p>', 'UpdateInvestigationGroupRequest$crossAccountConfigurations' => '<p>Used to configure cross-account access for an investigation group. It allows the investigation group to access resources in other accounts. </p>', ], ], 'DeleteInvestigationGroupPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInvestigationGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInvestigationGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'EncryptionConfiguration' => [ 'base' => '<p>Use this structure to specify a customer managed KMS key to use to encrypt investigation data. </p>', 'refs' => [ 'CreateInvestigationGroupInput$encryptionConfiguration' => '<p>Use this structure if you want to use a customer managed KMS key to encrypt your investigation data. If you omit this parameter, CloudWatch investigations will use an Amazon Web Services key to encrypt the data. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-KMS">Encryption of investigation data</a>.</p>', 'GetInvestigationGroupResponse$encryptionConfiguration' => '<p>Specifies the customer managed KMS key that the investigation group uses to encrypt data, if there is one. If not, the investigation group uses an Amazon Web Services key to encrypt the data.</p>', 'UpdateInvestigationGroupRequest$encryptionConfiguration' => '<p>Use this structure if you want to use a customer managed KMS key to encrypt your investigation data. If you omit this parameter, CloudWatch investigations will use an Amazon Web Services key to encrypt the data. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-KMS">Encryption of investigation data</a>.</p>', ], ], 'EncryptionConfigurationType' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$type' => '<p>Displays whether investigation data is encrypted by a customer managed key or an Amazon Web Services owned key.</p>', ], ], 'ForbiddenException' => [ 'base' => '<p>Access id denied for this operation, or this operation is not valid for the specified resource.</p>', 'refs' => [], ], 'GetInvestigationGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInvestigationGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetInvestigationGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInvestigationGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'IdentifierStringWithPatternAndLengthLimits' => [ 'base' => NULL, 'refs' => [ 'GetInvestigationGroupResponse$createdBy' => '<p>The name of the user who created the investigation group.</p>', 'GetInvestigationGroupResponse$lastModifiedBy' => '<p>The name of the user who created the investigation group.</p>', ], ], 'InternalServerException' => [ 'base' => '<p>An internal server error occurred. You can try again later.</p>', 'refs' => [], ], 'InvestigationGroupArn' => [ 'base' => NULL, 'refs' => [ 'CreateInvestigationGroupOutput$arn' => '<p>The ARN of the investigation group that you just created.</p>', 'GetInvestigationGroupPolicyResponse$investigationGroupArn' => '<p>The Amazon Resource Name (ARN) of the investigation group that you want to view the policy of.</p>', 'GetInvestigationGroupResponse$arn' => '<p>The Amazon Resource Name (ARN) of the investigation group.</p>', 'ListInvestigationGroupsModel$arn' => '<p>The Amazon Resource Name (ARN) of the investigation group.</p>', 'PutInvestigationGroupPolicyResponse$investigationGroupArn' => '<p>The ARN of the investigation group that will use this policy.</p>', ], ], 'InvestigationGroupIdentifier' => [ 'base' => NULL, 'refs' => [ 'DeleteInvestigationGroupPolicyRequest$identifier' => '<p>Specify either the name or the ARN of the investigation group that you want to remove the policy from.</p>', 'DeleteInvestigationGroupRequest$identifier' => '<p>Specify either the name or the ARN of the investigation group that you want to delete.</p>', 'GetInvestigationGroupPolicyRequest$identifier' => '<p>Specify either the name or the ARN of the investigation group that you want to view the policy of.</p>', 'GetInvestigationGroupRequest$identifier' => '<p>Specify either the name or the ARN of the investigation group that you want to view. This is used to set the name of the investigation group.</p>', 'PutInvestigationGroupPolicyRequest$identifier' => '<p>Specify either the name or the ARN of the investigation group that you want to assign the policy to.</p>', 'UpdateInvestigationGroupRequest$identifier' => '<p>Specify either the name or the ARN of the investigation group that you want to modify.</p>', ], ], 'InvestigationGroupPolicyDocument' => [ 'base' => NULL, 'refs' => [ 'GetInvestigationGroupPolicyResponse$policy' => '<p>The policy, in JSON format.</p>', 'PutInvestigationGroupPolicyRequest$policy' => '<p>The policy, in JSON format.</p>', ], ], 'InvestigationGroups' => [ 'base' => NULL, 'refs' => [ 'ListInvestigationGroupsOutput$investigationGroups' => '<p>An array of structures, where each structure contains the information about one investigation group in the account.</p>', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$kmsKeyId' => '<p>If the investigation group uses a customer managed key for encryption, this field displays the ID of that key.</p>', ], ], 'ListInvestigationGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListInvestigationGroupsInputMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListInvestigationGroupsInput$maxResults' => '<p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.</p>', ], ], 'ListInvestigationGroupsModel' => [ 'base' => '<p>This structure contains information about one investigation group in the account.</p>', 'refs' => [ 'InvestigationGroups$member' => NULL, ], ], 'ListInvestigationGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'GetInvestigationGroupResponse$createdAt' => '<p>The date and time that the investigation group was created.</p>', 'GetInvestigationGroupResponse$lastModifiedAt' => '<p>The date and time that the investigation group was most recently modified.</p>', ], ], 'PutInvestigationGroupPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutInvestigationGroupPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => '<p>The specified resource doesn\'t exist.</p>', 'refs' => [], ], 'Retention' => [ 'base' => NULL, 'refs' => [ 'CreateInvestigationGroupInput$retentionInDays' => '<p>Specify how long that investigation data is kept. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Retention.html">Operational investigation data retention</a>. </p> <p>If you omit this parameter, the default of 90 days is used.</p>', 'GetInvestigationGroupResponse$retentionInDays' => '<p>Specifies how long that investigation data is kept.</p>', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateInvestigationGroupInput$roleArn' => '<p>Specify the ARN of the IAM role that CloudWatch investigations will use when it gathers investigation data. The permissions in this role determine which of your resources that CloudWatch investigations will have access to during investigations.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-Security-Data">How to control what data CloudWatch investigations has access to during investigations</a>.</p>', 'CrossAccountConfiguration$sourceRoleArn' => '<p>The ARN of an existing role which will be used to do investigations on your behalf. </p>', 'GetInvestigationGroupResponse$roleArn' => '<p>The ARN of the IAM role that the investigation group uses for permissions to gather data.</p>', 'UpdateInvestigationGroupRequest$roleArn' => '<p>Specify this field if you want to change the IAM role that CloudWatch investigations will use when it gathers investigation data. To do so, specify the ARN of the new role.</p> <p>The permissions in this role determine which of your resources that CloudWatch investigations will have access to during investigations.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-Security-Data">How to control what data CloudWatch investigations has access to during investigations</a>.</p>', ], ], 'SNSTopicArn' => [ 'base' => NULL, 'refs' => [ 'ChatbotNotificationChannel$key' => NULL, ], ], 'SensitiveStringWithLengthLimits' => [ 'base' => NULL, 'refs' => [ 'ListInvestigationGroupsInput$nextToken' => '<p>Include this value, if it was returned by the previous operation, to get the next set of service operations.</p>', 'ListInvestigationGroupsOutput$nextToken' => '<p>Include this value in your next use of this operation to get the next set of service operations.</p>', ], ], 'ServiceQuotaExceededException' => [ 'base' => '<p>This request exceeds a service quota.</p>', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'ForbiddenException$message' => NULL, 'InternalServerException$message' => NULL, 'ListTagsForResourceRequest$resourceArn' => '<p>The ARN of the CloudWatch investigations resource that you want to view tags for. You can use the <code>ListInvestigationGroups</code> operation to find the ARNs of investigation groups.</p> <p>The ARN format for an investigation group is <code>arn:aws:aiops:<i>Region</i>:<i>account-id</i>:investigation-group:<i>investigation-group-id</i> </code>.</p>', 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ServiceQuotaExceededException$resourceId' => '<p>The resource that caused the quota exception.</p>', 'ServiceQuotaExceededException$resourceType' => '<p>The type of resource that caused the quota exception.</p>', 'ServiceQuotaExceededException$serviceCode' => '<p>This name of the service associated with the error.</p>', 'ServiceQuotaExceededException$quotaCode' => '<p>This quota that was exceeded.</p>', 'TagResourceRequest$resourceArn' => '<p>The Amazon Resource Name (ARN) of the resource that you want to apply the tags to. You can use the <code>ListInvestigationGroups</code> operation to find the ARNs of investigation groups.</p>', 'ThrottlingException$message' => NULL, 'UntagResourceRequest$resourceArn' => '<p>The Amazon Resource Name (ARN) of the resource that you want to remove the tags from. You can use the<code>ListInvestigationGroups</code> operation to find the ARNs of investigation groups.</p>', 'ValidationException$message' => NULL, ], ], 'StringWithPatternAndLengthLimits' => [ 'base' => NULL, 'refs' => [ 'CreateInvestigationGroupInput$name' => '<p>Provides a name for the investigation group.</p>', 'GetInvestigationGroupResponse$name' => '<p>The name of the investigation group.</p>', 'ListInvestigationGroupsModel$name' => '<p>The name of the investigation group.</p>', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyBoundaries$member' => NULL, 'TagKeys$member' => NULL, 'Tags$key' => NULL, ], ], 'TagKeyBoundaries' => [ 'base' => NULL, 'refs' => [ 'CreateInvestigationGroupInput$tagKeyBoundaries' => '<p>Enter the existing custom tag keys for custom applications in your system. Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources. For example, to discover that an Amazon ECS service depends on an Amazon RDS database, CloudWatch investigations can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven\'t deployed these features, CloudWatch investigations will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by CloudWatch investigations in these cases.</p> <p>You don\'t need to enter tags created by myApplications or CloudFormation, because CloudWatch investigations can automatically detect those tags.</p>', 'GetInvestigationGroupResponse$tagKeyBoundaries' => '<p>Displays the custom tag keys for custom applications in your system that you have specified in the investigation group. Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources. </p>', 'UpdateInvestigationGroupRequest$tagKeyBoundaries' => '<p>Enter the existing custom tag keys for custom applications in your system. Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources. For example, to discover that an Amazon ECS service depends on an Amazon RDS database, CloudWatch investigations can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven\'t deployed these features, CloudWatch investigations will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by CloudWatch investigations in these cases.</p> <p>You don\'t need to enter tags created by myApplications or CloudFormation, because CloudWatch investigations can automatically detect those tags.</p>', ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '<p>The list of tag keys to remove from the resource.</p>', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateInvestigationGroupInput$tags' => '<p>A list of key-value pairs to associate with the investigation group. You can associate as many as 50 tags with an investigation group. To be able to associate tags when you create the investigation group, you must have the <code>cloudwatch:TagResource</code> permission.</p> <p>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.</p>', 'ListTagsForResourceOutput$tags' => '<p>The list of tag keys and values associated with the resource you specified.</p>', 'TagResourceRequest$tags' => '<p>The list of key-value pairs to associate with the resource.</p>', ], ], 'ThrottlingException' => [ 'base' => '<p>The request was throttled because of quota limits. You can try again later.</p>', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInvestigationGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInvestigationGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '<p>This operation or its parameters aren\'t formatted correctly.</p>', 'refs' => [], ], ],];
