datadog_api_client 1.1.0 → 1.2.0

data/docs/v1/AWSAccountDeleteRequest.md

@@ -0,0 +1,22 @@
+# DatadogAPIClient::V1::AWSAccountDeleteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_key_id** | **String** | Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. | [optional] |
+| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] |
+| **role_name** | **String** | Your Datadog role delegation name. | [optional] |
+
+## Example
+
+```ruby
+require 'datadog_api_client/v1'
+
+instance = DatadogAPIClient::V1::AWSAccountDeleteRequest.new(
+  access_key_id: null,
+  account_id: 1234567,
+  role_name: DatadogAWSIntegrationRole
+)
+```
+

data/docs/v1/AWSIntegrationAPI.md

@@ -19,9 +19,10 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <AWSAccountCreateResponse> create_aws_account(body)
 
-Create an AWS integration
-
-Create a Datadog-Amazon Web Services integration. Using the `POST` method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. A unique AWS Account ID for role based authentication.
+Create a Datadog-Amazon Web Services integration.
+Using the `POST` method updates your integration configuration
+by adding your new configuration to the existing one in your Datadog organization.
+A unique AWS Account ID for role based authentication.
 
 ### Examples
 
@@ -81,8 +82,6 @@ end
 
 > Object create_aws_tag_filter(body)
 
-Set an AWS tag filter
-
 Set an AWS tag filter.
 
 ### Examples
@@ -143,8 +142,6 @@ end
 
 > <AWSAccountCreateResponse> create_new_aws_external_id(body)
 
-Generate a new external ID
-
 Generate a new AWS external ID for a given AWS account ID and role name pair.
 
 ### Examples
@@ -152,7 +149,7 @@ Generate a new AWS external ID for a given AWS account ID and role name pair.
 ```ruby
 require 'datadog_api_client'
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
-body = DatadogAPIClient::V1::AWSAccount.new # AWSAccount | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://github.com/DataDog/documentation/blob/master/integrations/amazon_web_services/#installation).
+body = DatadogAPIClient::V1::AWSAccount.new # AWSAccount | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://docs.datadoghq.com/integrations/amazon_web_services/#setup).
 
 begin
   # Generate a new external ID
@@ -185,7 +182,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **body** | [**AWSAccount**](AWSAccount.md) | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://github.com/DataDog/documentation/blob/master/integrations/amazon_web_services/#installation). |  |
+| **body** | [**AWSAccount**](AWSAccount.md) | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://docs.datadoghq.com/integrations/amazon_web_services/#setup). |  |
 
 ### Return type
 
@@ -205,8 +202,6 @@ end
 
 > Object delete_aws_account(body)
 
-Delete an AWS integration
-
 Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
 
 ### Examples
@@ -214,7 +209,7 @@ Delete a Datadog-AWS integration matching the specified `account_id` and `role_n
 ```ruby
 require 'datadog_api_client'
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
-body = DatadogAPIClient::V1::AWSAccount.new # AWSAccount | AWS request object
+body = DatadogAPIClient::V1::AWSAccountDeleteRequest.new # AWSAccountDeleteRequest | AWS request object
 
 begin
   # Delete an AWS integration
@@ -247,7 +242,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **body** | [**AWSAccount**](AWSAccount.md) | AWS request object |  |
+| **body** | [**AWSAccountDeleteRequest**](AWSAccountDeleteRequest.md) | AWS request object |  |
 
 ### Return type
 
@@ -267,8 +262,6 @@ end
 
 > Object delete_aws_tag_filter(body)
 
-Delete a tag filtering entry
-
 Delete a tag filtering entry.
 
 ### Examples
@@ -329,8 +322,6 @@ end
 
 > Array&lt;String&gt; list_available_aws_namespaces
 
-List namespace rules
-
 List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
 
 ### Examples
@@ -388,8 +379,6 @@ This endpoint does not need any parameter.
 
 > <AWSAccountListResponse> list_aws_accounts(opts)
 
-List all AWS integrations
-
 List all Datadog-AWS integrations available in your Datadog organization.
 
 ### Examples
@@ -456,8 +445,6 @@ end
 
 > <AWSTagFilterListResponse> list_aws_tag_filters(account_id)
 
-Get all AWS tag filters
-
 Get all AWS tag filters.
 
 ### Examples
@@ -518,8 +505,6 @@ end
 
 > Object update_aws_account(body, opts)
 
-Update an AWS integration
-
 Update a Datadog-Amazon Web Services integration.
 
 ### Examples

data/docs/v1/AWSLogsIntegrationAPI.md

@@ -17,9 +17,14 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <AWSLogsAsyncResponse> check_aws_logs_lambda_async(body)
 
-Check that an AWS Lambda Function exists
+Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input
+is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this
+endpoint can be polled intermittently instead of blocking.
 
-Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking.  - Returns a status of 'created' when it's checking if the Lambda exists in the account. - Returns a status of 'waiting' while checking. - Returns a status of 'checked and ok' if the Lambda exists. - Returns a status of 'error' if the Lambda does not exist.
+- Returns a status of 'created' when it's checking if the Lambda exists in the account.
+- Returns a status of 'waiting' while checking.
+- Returns a status of 'checked and ok' if the Lambda exists.
+- Returns a status of 'error' if the Lambda does not exist.
 
 ### Examples
 
@@ -79,9 +84,16 @@ end
 
 > <AWSLogsAsyncResponse> check_aws_logs_services_async(body)
 
-Check permissions for log services
+Test if permissions are present to add log-forwarding triggers for the
+given services and AWS account. Input is the same as for `EnableAWSLogServices`.
+Done async, so can be repeatedly polled in a non-blocking fashion until
+the async request completes.
 
-Test if permissions are present to add log-forwarding triggers for the given services and AWS account. Input is the same as for `EnableAWSLogServices`. Done async, so can be repeatedly polled in a non-blocking fashion until the async request completes.  - Returns a status of `created` when it's checking if the permissions exists   in the AWS account. - Returns a status of `waiting` while checking. - Returns a status of `checked and ok` if the Lambda exists. - Returns a status of `error` if the Lambda does not exist.
+- Returns a status of `created` when it's checking if the permissions exists
+  in the AWS account.
+- Returns a status of `waiting` while checking.
+- Returns a status of `checked and ok` if the Lambda exists.
+- Returns a status of `error` if the Lambda does not exist.
 
 ### Examples
 
@@ -141,8 +153,6 @@ end
 
 > Object create_aws_lambda_arn(body)
 
-Add AWS Log Lambda ARN
-
 Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection.
 
 ### Examples
@@ -203,8 +213,6 @@ end
 
 > Object delete_aws_lambda_arn(body)
 
-Delete an AWS Logs integration
-
 Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account.
 
 ### Examples
@@ -265,8 +273,6 @@ end
 
 > Object enable_aws_log_services(body)
 
-Enable an AWS Logs integration
-
 Enable automatic log collection for a list of services. This should be run after running `CreateAWSLambdaARN` to save the configuration.
 
 ### Examples
@@ -327,8 +333,6 @@ end
 
 > <Array<AWSLogsListResponse>> list_aws_logs_integrations
 
-List all AWS Logs integrations
-
 List all Datadog-AWS Logs integrations configured in your Datadog account.
 
 ### Examples
@@ -386,8 +390,6 @@ This endpoint does not need any parameter.
 
 > <Array<AWSLogsListServicesResponse>> list_aws_logs_services
 
-Get list of AWS log ready services
-
 Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
 
 ### Examples

data/docs/v1/AuthenticationAPI.md

@@ -11,8 +11,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <AuthenticationValidationResponse> validate
 
-Validate API key
-
 Check if the API key (not the APP key) is valid. If invalid, a 403 is returned.
 
 ### Examples

data/docs/v1/AzureIntegrationAPI.md

@@ -15,9 +15,13 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > Object create_azure_integration(body)
 
-Create an Azure integration
+Create a Datadog-Azure integration.
 
-Create a Datadog-Azure integration.  Using the `POST` method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization.  Using the `PUT` method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization.
+Using the `POST` method updates your integration configuration by adding your new
+configuration to the existing one in your Datadog organization.
+
+Using the `PUT` method updates your integration configuration by replacing your
+current configuration with the new one sent to your Datadog organization.
 
 ### Examples
 
@@ -77,8 +81,6 @@ end
 
 > Object delete_azure_integration(body)
 
-Delete an Azure integration
-
 Delete a given Datadog-Azure integration from your Datadog account.
 
 ### Examples
@@ -139,8 +141,6 @@ end
 
 > <Array<AzureAccount>> list_azure_integration
 
-List all Azure integrations
-
 List all Datadog-Azure integrations configured in your Datadog account.
 
 ### Examples
@@ -198,8 +198,6 @@ This endpoint does not need any parameter.
 
 > Object update_azure_host_filters(body)
 
-Update Azure integration host filters
-
 Update the defined list of host filters for a given Datadog-Azure integration.
 
 ### Examples
@@ -260,9 +258,9 @@ end
 
 > Object update_azure_integration(body)
 
-Update an Azure integration
-
-Update a Datadog-Azure integration. Requires an existing `tenant_name` and `client_id`. Any other fields supplied will overwrite existing values. To overwrite `tenant_name` or `client_id`, use `new_tenant_name` and `new_client_id`. To leave a field unchanged, do not supply that field in the payload.
+Update a Datadog-Azure integration. Requires an existing `tenant_name` and `client_id`.
+Any other fields supplied will overwrite existing values. To overwrite `tenant_name` or `client_id`,
+use `new_tenant_name` and `new_client_id`. To leave a field unchanged, do not supply that field in the payload.
 
 ### Examples
 

data/docs/v1/Dashboard.md

@@ -13,6 +13,7 @@
 | **modified_at** | **Time** | Modification date of the dashboard. | [optional][readonly] |
 | **notify_list** | **Array<String>** | List of handles of users to notify when changes are made to this dashboard. | [optional] |
 | **reflow_type** | [**DashboardReflowType**](DashboardReflowType.md) |  | [optional] |
+| **restricted_roles** | **Array<String>** | A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. Overrides the `is_read_only` property if both are present. **This feature is currently in beta.** | [optional] |
 | **template_variable_presets** | [**Array<DashboardTemplateVariablePreset>**](DashboardTemplateVariablePreset.md) | Array of template variables saved views. | [optional] |
 | **template_variables** | [**Array<DashboardTemplateVariable>**](DashboardTemplateVariable.md) | List of template variables for this dashboard. | [optional] |
 | **title** | **String** | Title of the dashboard. |  |
@@ -34,6 +35,7 @@ instance = DatadogAPIClient::V1::Dashboard.new(
   modified_at: null,
   notify_list: null,
   reflow_type: null,
+  restricted_roles: null,
   template_variable_presets: null,
   template_variables: null,
   title: ,

data/docs/v1/DashboardListsAPI.md

@@ -15,8 +15,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <DashboardList> create_dashboard_list(body)
 
-Create a dashboard list
-
 Create an empty dashboard list.
 
 ### Examples
@@ -77,8 +75,6 @@ end
 
 > <DashboardListDeleteResponse> delete_dashboard_list(list_id)
 
-Delete a dashboard list
-
 Delete a dashboard list.
 
 ### Examples
@@ -139,8 +135,6 @@ end
 
 > <DashboardList> get_dashboard_list(list_id)
 
-Get a dashboard list
-
 Fetch an existing dashboard list's definition.
 
 ### Examples
@@ -201,8 +195,6 @@ end
 
 > <DashboardListListResponse> list_dashboard_lists
 
-Get all dashboard lists
-
 Fetch all of your existing dashboard list definitions.
 
 ### Examples
@@ -260,8 +252,6 @@ This endpoint does not need any parameter.
 
 > <DashboardList> update_dashboard_list(list_id, body)
 
-Update a dashboard list
-
 Update the name of a dashboard list.
 
 ### Examples

data/docs/v1/DashboardsAPI.md

@@ -15,9 +15,8 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <Dashboard> create_dashboard(body)
 
-Create a new dashboard
-
-Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended. Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers.
+Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended.
+Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers.
 
 ### Examples
 
@@ -77,8 +76,6 @@ end
 
 > <DashboardDeleteResponse> delete_dashboard(dashboard_id)
 
-Delete a dashboard
-
 Delete a dashboard using the specified ID.
 
 ### Examples
@@ -139,8 +136,6 @@ end
 
 > <Dashboard> get_dashboard(dashboard_id)
 
-Get a dashboard
-
 Get a dashboard using the specified ID.
 
 ### Examples
@@ -201,9 +196,10 @@ end
 
 > <DashboardSummary> list_dashboards(opts)
 
-Get all dashboards
+Get all dashboards.
 
-Get all dashboards.  **Note**: This query will only return custom created or cloned dashboards. This query will not return preset dashboards.
+**Note**: This query will only return custom created or cloned dashboards.
+This query will not return preset dashboards.
 
 ### Examples
 
@@ -265,8 +261,6 @@ end
 
 > <Dashboard> update_dashboard(dashboard_id, body)
 
-Update a dashboard
-
 Update a dashboard using the specified ID.
 
 ### Examples

data/docs/v1/DowntimesAPI.md

@@ -17,8 +17,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > cancel_downtime(downtime_id)
 
-Cancel a downtime
-
 Cancel a downtime.
 
 ### Examples
@@ -78,8 +76,6 @@ nil (empty response body)
 
 > <CanceledDowntimesIds> cancel_downtimes_by_scope(body)
 
-Cancel downtimes by scope
-
 Delete all downtimes that match the scope of `X`.
 
 ### Examples
@@ -140,8 +136,6 @@ end
 
 > <Downtime> create_downtime(body)
 
-Schedule a downtime
-
 Schedule a downtime.
 
 ### Examples
@@ -202,8 +196,6 @@ end
 
 > <Downtime> get_downtime(downtime_id)
 
-Get a downtime
-
 Get downtime detail by `downtime_id`.
 
 ### Examples
@@ -264,8 +256,6 @@ end
 
 > <Array<Downtime>> list_downtimes(opts)
 
-Get all downtimes
-
 Get all scheduled downtimes.
 
 ### Examples
@@ -328,8 +318,6 @@ end
 
 > <Array<Downtime>> list_monitor_downtimes(monitor_id)
 
-Get all downtimes for a monitor
-
 Get all downtimes for the specified monitor
 
 ### Examples
@@ -390,8 +378,6 @@ end
 
 > <Downtime> update_downtime(downtime_id, body)
 
-Update a downtime
-
 Update a single downtime by `downtime_id`.
 
 ### Examples