/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the codeguru-security-2018-05-10.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.CodeGuruSecurity.Model;
namespace Amazon.CodeGuruSecurity
{
///
/// Interface for accessing CodeGuruSecurity
///
///
///
/// Amazon CodeGuru Security is in preview release and is subject to change.
///
///
///
/// This section provides documentation for the Amazon CodeGuru Security API operations.
/// CodeGuru Security is a service that uses program analysis and machine learning to
/// detect security policy violations and vulnerabilities, and recommends ways to address
/// these security risks.
///
///
///
/// By proactively detecting and providing recommendations for addressing security risks,
/// CodeGuru Security improves the overall security of your application code. For more
/// information about CodeGuru Security, see the Amazon
/// CodeGuru Security User Guide.
///
///
public partial interface IAmazonCodeGuruSecurity : IAmazonService, IDisposable
{
///
/// Paginators for the service
///
ICodeGuruSecurityPaginatorFactory Paginators { get; }
#region BatchGetFindings
///
/// Returns a list of all requested findings.
///
/// Container for the necessary parameters to execute the BatchGetFindings service method.
///
/// The response from the BatchGetFindings service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for BatchGetFindings Operation
BatchGetFindingsResponse BatchGetFindings(BatchGetFindingsRequest request);
///
/// Returns a list of all requested findings.
///
/// Container for the necessary parameters to execute the BatchGetFindings service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the BatchGetFindings service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for BatchGetFindings Operation
Task BatchGetFindingsAsync(BatchGetFindingsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateScan
///
/// Use to create a scan using code uploaded to an S3 bucket.
///
/// Container for the necessary parameters to execute the CreateScan service method.
///
/// The response from the CreateScan service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for CreateScan Operation
CreateScanResponse CreateScan(CreateScanRequest request);
///
/// Use to create a scan using code uploaded to an S3 bucket.
///
/// Container for the necessary parameters to execute the CreateScan service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateScan service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for CreateScan Operation
Task CreateScanAsync(CreateScanRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateUploadUrl
///
/// Generates a pre-signed URL and request headers used to upload a code resource.
///
///
///
/// You can upload your code resource to the URL and add the request headers using any
/// HTTP client.
///
///
/// Container for the necessary parameters to execute the CreateUploadUrl service method.
///
/// The response from the CreateUploadUrl service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for CreateUploadUrl Operation
CreateUploadUrlResponse CreateUploadUrl(CreateUploadUrlRequest request);
///
/// Generates a pre-signed URL and request headers used to upload a code resource.
///
///
///
/// You can upload your code resource to the URL and add the request headers using any
/// HTTP client.
///
///
/// Container for the necessary parameters to execute the CreateUploadUrl service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateUploadUrl service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for CreateUploadUrl Operation
Task CreateUploadUrlAsync(CreateUploadUrlRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetAccountConfiguration
///
/// Use to get account level configuration.
///
/// Container for the necessary parameters to execute the GetAccountConfiguration service method.
///
/// The response from the GetAccountConfiguration service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for GetAccountConfiguration Operation
GetAccountConfigurationResponse GetAccountConfiguration(GetAccountConfigurationRequest request);
///
/// Use to get account level configuration.
///
/// Container for the necessary parameters to execute the GetAccountConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetAccountConfiguration service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for GetAccountConfiguration Operation
Task GetAccountConfigurationAsync(GetAccountConfigurationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetFindings
///
/// Returns a list of all findings generated by a particular scan.
///
/// Container for the necessary parameters to execute the GetFindings service method.
///
/// The response from the GetFindings service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for GetFindings Operation
GetFindingsResponse GetFindings(GetFindingsRequest request);
///
/// Returns a list of all findings generated by a particular scan.
///
/// Container for the necessary parameters to execute the GetFindings service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetFindings service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for GetFindings Operation
Task GetFindingsAsync(GetFindingsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetMetricsSummary
///
/// Returns top level metrics about an account from a specified date, including number
/// of open findings, the categories with most findings, the scans with most open findings,
/// and scans with most open critical findings.
///
/// Container for the necessary parameters to execute the GetMetricsSummary service method.
///
/// The response from the GetMetricsSummary service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for GetMetricsSummary Operation
GetMetricsSummaryResponse GetMetricsSummary(GetMetricsSummaryRequest request);
///
/// Returns top level metrics about an account from a specified date, including number
/// of open findings, the categories with most findings, the scans with most open findings,
/// and scans with most open critical findings.
///
/// Container for the necessary parameters to execute the GetMetricsSummary service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetMetricsSummary service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for GetMetricsSummary Operation
Task GetMetricsSummaryAsync(GetMetricsSummaryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetScan
///
/// Returns details about a scan, including whether or not a scan has completed.
///
/// Container for the necessary parameters to execute the GetScan service method.
///
/// The response from the GetScan service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
/// REST API Reference for GetScan Operation
GetScanResponse GetScan(GetScanRequest request);
///
/// Returns details about a scan, including whether or not a scan has completed.
///
/// Container for the necessary parameters to execute the GetScan service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetScan service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
/// REST API Reference for GetScan Operation
Task GetScanAsync(GetScanRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListFindingsMetrics
///
/// Returns metrics about all findings in an account within a specified time range.
///
/// Container for the necessary parameters to execute the ListFindingsMetrics service method.
///
/// The response from the ListFindingsMetrics service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for ListFindingsMetrics Operation
ListFindingsMetricsResponse ListFindingsMetrics(ListFindingsMetricsRequest request);
///
/// Returns metrics about all findings in an account within a specified time range.
///
/// Container for the necessary parameters to execute the ListFindingsMetrics service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListFindingsMetrics service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for ListFindingsMetrics Operation
Task ListFindingsMetricsAsync(ListFindingsMetricsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListScans
///
/// Returns a list of all the standard scans in an account. Does not return express scans.
///
/// Container for the necessary parameters to execute the ListScans service method.
///
/// The response from the ListScans service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for ListScans Operation
ListScansResponse ListScans(ListScansRequest request);
///
/// Returns a list of all the standard scans in an account. Does not return express scans.
///
/// Container for the necessary parameters to execute the ListScans service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListScans service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for ListScans Operation
Task ListScansAsync(ListScansRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Returns a list of all tags associated with a scan.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Returns a list of all tags associated with a scan.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Use to add one or more tags to an existing scan.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Use to add one or more tags to an existing scan.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Use to remove one or more tags from an existing scan.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Use to remove one or more tags from an existing scan.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The requested operation would cause a conflict with the current state of a service
/// resource associated with the request. Resolve the conflict before retrying this request.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateAccountConfiguration
///
/// Use to update account-level configuration with an encryption key.
///
/// Container for the necessary parameters to execute the UpdateAccountConfiguration service method.
///
/// The response from the UpdateAccountConfiguration service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for UpdateAccountConfiguration Operation
UpdateAccountConfigurationResponse UpdateAccountConfiguration(UpdateAccountConfigurationRequest request);
///
/// Use to update account-level configuration with an encryption key.
///
/// Container for the necessary parameters to execute the UpdateAccountConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateAccountConfiguration service method, as returned by CodeGuruSecurity.
///
/// You do not have sufficient access to perform this action.
///
///
/// The server encountered an internal error and is unable to complete the request.
///
///
/// The resource specified in the request was not found.
///
///
/// The request was denied due to request throttling.
///
///
/// The input fails to satisfy the specified constraints.
///
/// REST API Reference for UpdateAccountConfiguration Operation
Task UpdateAccountConfigurationAsync(UpdateAccountConfigurationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}