AWS.Tools.CodeGuruSecurity.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CodeGuruSecurity</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CGS.AddCGSResourceTagCmdlet"> <summary> Use to add one or more tags to an existing scan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.AddCGSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling <code>ListScans</code> or <code>GetScan</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.AddCGSResourceTagCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:</para><ul><li><para>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</para></li><li><para>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.AddCGSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.AddCGSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.AddCGSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.GetCGSAccountConfigurationCmdlet"> <summary> Use to get account level configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSAccountConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EncryptionConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.GetAccountConfigurationResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.GetAccountConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingCmdlet"> <summary> Returns a list of all findings generated by a particular scan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingCmdlet.ScanName"> <summary> <para> <para>The name of the scan you want to retrieve findings from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingCmdlet.Status"> <summary> <para> <para>The status of the findings you want to get. Pass either <code>Open</code>, <code>Closed</code>, or <code>All</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code> element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve additional results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingCmdlet.NextToken"> <summary> <para> <para>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Findings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.GetFindingsResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.GetFindingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScanName parameter. The -PassThru parameter is deprecated, use -Select '^ScanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingsMetricListCmdlet"> <summary> Returns metrics about all findings in an account within a specified time range. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingsMetricListCmdlet.EndDate"> <summary> <para> <para>The end date of the interval which you want to retrieve metrics from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingsMetricListCmdlet.StartDate"> <summary> <para> <para>The start date of the interval which you want to retrieve metrics from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingsMetricListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code> element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve additional results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingsMetricListCmdlet.NextToken"> <summary> <para> <para>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSFindingsMetricListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FindingsMetrics'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.ListFindingsMetricsResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.ListFindingsMetricsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.GetCGSGetFindingCmdlet"> <summary> Returns a list of all requested findings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSGetFindingCmdlet.FindingIdentifier"> <summary> <para> <para>A list of finding identifiers. Each identifier consists of a <code>scanName</code> and a <code>findingId</code>. You retrieve the <code>findingId</code> when you call <code>GetFindings</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSGetFindingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.BatchGetFindingsResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.BatchGetFindingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.GetCGSMetricsSummaryCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSMetricsSummaryCmdlet.Date"> <summary> <para> <para>The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years since metrics data is only stored for two years. If a date outside of this range is passed, the response will be empty.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSMetricsSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MetricsSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.GetMetricsSummaryResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.GetMetricsSummaryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSMetricsSummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Date parameter. The -PassThru parameter is deprecated, use -Select '^Date' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.GetCGSResourceTagCmdlet"> <summary> Returns a list of all tags associated with a scan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling <code>ListScans</code> or <code>GetScan</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.GetCGSScanCmdlet"> <summary> Returns details about a scan, including whether or not a scan has completed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSScanCmdlet.RunId"> <summary> <para> <para>UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the <code>CreateScan</code> operation. Defaults to the latest scan run if missing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSScanCmdlet.ScanName"> <summary> <para> <para>The name of the scan you want to view details about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSScanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.GetScanResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.GetScanResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSScanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScanName parameter. The -PassThru parameter is deprecated, use -Select '^ScanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.GetCGSScanListCmdlet"> <summary> Returns a list of all the standard scans in an account. Does not return express scans. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSScanListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code> element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve additional results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSScanListCmdlet.NextToken"> <summary> <para> <para>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.GetCGSScanListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.ListScansResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.ListScansResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet"> <summary> Use to create a scan using code uploaded to an S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet.AnalysisType"> <summary> <para> <para>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet.ResourceId_CodeArtifactId"> <summary> <para> <para>The identifier for the code file uploaded to the resource where a finding was detected.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet.ScanName"> <summary> <para> <para>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type. If not specified, it will be auto generated. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet.ScanType"> <summary> <para> <para>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</para><para><code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</para><ul><li><para>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</para></li><li><para>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet.ClientToken"> <summary> <para> <para>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.CreateScanResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.CreateScanResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScanName parameter. The -PassThru parameter is deprecated, use -Select '^ScanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSScanCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.NewCGSUploadUrlCmdlet"> <summary> Generates a pre-signed URL and request headers used to upload a code resource. <para> You can upload your code resource to the URL and add the request headers using any HTTP client. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSUploadUrlCmdlet.ScanName"> <summary> <para> <para>The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this <code>scanName</code> when you call <code>CreateScan</code> on the code resource you upload to this URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSUploadUrlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.CreateUploadUrlResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.CreateUploadUrlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSUploadUrlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScanName parameter. The -PassThru parameter is deprecated, use -Select '^ScanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.NewCGSUploadUrlCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.RemoveCGSResourceTagCmdlet"> <summary> Use to remove one or more tags from an existing scan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.RemoveCGSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling <code>ListScans</code> or <code>GetScan</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.RemoveCGSResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of keys for each tag you want to remove from a scan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.RemoveCGSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.RemoveCGSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.RemoveCGSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CGS.UpdateCGSAccountConfigurationCmdlet"> <summary> Use to update account-level configuration with an encryption key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.UpdateCGSAccountConfigurationCmdlet.EncryptionConfig_KmsKeyArn"> <summary> <para> <para>The KMS key ARN to use for encryption. This must be provided as a header when uploading your code resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.UpdateCGSAccountConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EncryptionConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeGuruSecurity.Model.UpdateAccountConfigurationResponse). Specifying the name of a property of type Amazon.CodeGuruSecurity.Model.UpdateAccountConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.UpdateCGSAccountConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EncryptionConfig_KmsKeyArn parameter. The -PassThru parameter is deprecated, use -Select '^EncryptionConfig_KmsKeyArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CGS.UpdateCGSAccountConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |