openapi: 3.2.0 info: version: 2020-12-01 x-release: v4 title: Amazon DevOps Guru Monitored Resources API description: Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: devops-guru x-aws-signingName: devops-guru x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/devops-guru-2020-12-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://devops-guru.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon DevOps Guru multi-region endpoint - url: https://devops-guru.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon DevOps Guru multi-region endpoint - url: http://devops-guru.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon DevOps Guru endpoint for China (Beijing) and China (Ningxia) - url: https://devops-guru.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon DevOps Guru endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Monitored Resources paths: /monitoredResources: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListMonitoredResources description: Returns the list of all log groups that are being monitored and tagged by DevOps Guru. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListMonitoredResourcesResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: Filters: description: ' Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status. ' type: object properties: ResourcePermission: allOf: - $ref: '#/components/schemas/ResourcePermission' - description: ' The permission status of a resource. ' ResourceTypeFilters: allOf: - $ref: '#/components/schemas/ResourceTypeFilters' - description: ' The type of resource that you wish to retrieve, such as log groups. ' MaxResults: description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. type: integer minimum: 1 maximum: 50 NextToken: description: The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 36 maxLength: 36 tags: - Monitored Resources summary: List monitored resources x-summary-source: derived components: schemas: AppBoundaryKey: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ minLength: 1 maxLength: 128 ResourceTypeFilter: type: string enum: - LOG_GROUPS - CLOUDFRONT_DISTRIBUTION - DYNAMODB_TABLE - EC2_NAT_GATEWAY - ECS_CLUSTER - ECS_SERVICE - EKS_CLUSTER - ELASTIC_BEANSTALK_ENVIRONMENT - ELASTIC_LOAD_BALANCER_LOAD_BALANCER - ELASTIC_LOAD_BALANCING_V2_LOAD_BALANCER - ELASTIC_LOAD_BALANCING_V2_TARGET_GROUP - ELASTICACHE_CACHE_CLUSTER - ELASTICSEARCH_DOMAIN - KINESIS_STREAM - LAMBDA_FUNCTION - OPEN_SEARCH_SERVICE_DOMAIN - RDS_DB_INSTANCE - RDS_DB_CLUSTER - REDSHIFT_CLUSTER - ROUTE53_HOSTED_ZONE - ROUTE53_HEALTH_CHECK - S3_BUCKET - SAGEMAKER_ENDPOINT - SNS_TOPIC - SQS_QUEUE - STEP_FUNCTIONS_ACTIVITY - STEP_FUNCTIONS_STATE_MACHINE TagCollection: type: object required: - AppBoundaryKey - TagValues properties: AppBoundaryKey: allOf: - $ref: '#/components/schemas/AppBoundaryKey' - description:

An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

 TagValues: allOf: - $ref: '#/components/schemas/TagValues' - description:

The values in an Amazon Web Services tag collection.

The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

description:

A collection of Amazon Web Services tags.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

 TagValues: type: array items: $ref: '#/components/schemas/TagValue' UuidNextToken: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 36 maxLength: 36 ResourceTypeFilters: type: array items: $ref: '#/components/schemas/ResourceTypeFilter' ResourceType: type: string pattern: ^[a-zA-Z]+[a-zA-Z0-9-_:]*$ minLength: 1 maxLength: 256 TagCollections: type: array items: $ref: '#/components/schemas/TagCollection' ThrottlingException: {} TagValue: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*|\*)$ minLength: 0 maxLength: 256 ResourceNotFoundException: {} StackNames: type: array items: $ref: '#/components/schemas/StackName' ResourcePermission: type: string enum: - FULL_PERMISSION - MISSING_PERMISSION ListMonitoredResourcesResponse: type: object required: - MonitoredResourceIdentifiers properties: MonitoredResourceIdentifiers: allOf: - $ref: '#/components/schemas/MonitoredResourceIdentifiers' - description: ' Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource. ' NextToken: allOf: - $ref: '#/components/schemas/UuidNextToken' - description: The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. CloudFormationCollection: type: object properties: StackNames: allOf: - $ref: '#/components/schemas/StackNames' - description: ' An array of CloudFormation stack names. ' description: ' Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide. ' Timestamp: type: string format: date-time StackName: type: string pattern: ^[a-zA-Z*]+[a-zA-Z0-9-]*$ minLength: 1 maxLength: 128 MonitoredResourceIdentifier: type: object properties: MonitoredResourceName: allOf: - $ref: '#/components/schemas/MonitoredResourceName' - description: ' The name of the resource being monitored. ' Type: allOf: - $ref: '#/components/schemas/ResourceType' - description: ' The type of resource being monitored. ' ResourcePermission: allOf: - $ref: '#/components/schemas/ResourcePermission' - description: ' The permission status of a resource. ' LastUpdated: allOf: - $ref: '#/components/schemas/Timestamp' - description: ' The time at which DevOps Guru last updated this resource. ' ResourceCollection: $ref: '#/components/schemas/ResourceCollection' description: ' Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource. ' MonitoredResourceIdentifiers: type: array items: $ref: '#/components/schemas/MonitoredResourceIdentifier' ResourceCollection: type: object properties: CloudFormation: allOf: - $ref: '#/components/schemas/CloudFormationCollection' - description: ' An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks. ' Tags: allOf: - $ref: '#/components/schemas/TagCollections' - description:

The Amazon Web Services tags that are used by resources in the resource collection.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

 description: ' A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. ' ValidationException: {} InternalServerException: {} MonitoredResourceName: type: string pattern: '[\.\-_\/#A-Za-z0-9]+' minLength: 1 maxLength: 512 parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/devops-guru/