@aws-sdk/client-securityhub 3.316.0 → 3.319.0

package/dist-types/commands/ListInvitationsCommand.d.ts

@@ -57,6 +57,27 @@ export interface ListInvitationsCommandOutput extends ListInvitationsResponse, _
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To list membership invitations to calling account
+ * ```javascript
+ * // The following example returns a list of Security Hub member invitations sent to the calling AWS account. Only accounts that are invited manually use this operation. It's not for use by accounts that are managed through AWS Organizations.
+ * const input = undefined;
+ * const command = new ListInvitationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Invitations": [
+ *     {
+ *       "AccountId": "123456789012",
+ *       "InvitationId": "7ab938c5d52d7904ad09f9e7c20cc4eb",
+ *       "InvitedAt": "2020-06-01T20:21:18.042000+00:00",
+ *       "MemberStatus": "ASSOCIATED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-membership-invitations-to-calling-account-1678295758285
+ * ```
+ *
  */
 export declare class ListInvitationsCommand extends $Command<ListInvitationsCommandInput, ListInvitationsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: ListInvitationsCommandInput;

package/dist-types/commands/ListMembersCommand.d.ts

@@ -59,6 +59,37 @@ export interface ListMembersCommandOutput extends ListMembersResponse, __Metadat
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To list member account details
+ * ```javascript
+ * // The following example returns details about member accounts for the calling Security Hub administrator account. The response includes member accounts that are managed through AWS Organizations and those that were invited manually.
+ * const input = undefined;
+ * const command = new ListMembersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Members": [
+ *     {
+ *       "AccountId": "111122223333",
+ *       "AdministratorId": "123456789012",
+ *       "InvitedAt": "2020-06-01T20:15:15.289000+00:00",
+ *       "MasterId": "123456789012",
+ *       "MemberStatus": "ASSOCIATED",
+ *       "UpdatedAt": "2020-06-01T20:15:15.289000+00:00"
+ *     },
+ *     {
+ *       "AccountId": "444455556666",
+ *       "AdministratorId": "123456789012",
+ *       "InvitedAt": "2020-06-01T20:15:15.289000+00:00",
+ *       "MasterId": "123456789012",
+ *       "MemberStatus": "ASSOCIATED",
+ *       "UpdatedAt": "2020-06-01T20:15:15.289000+00:00"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-member-account-details-1678385639113
+ * ```
+ *
  */
 export declare class ListMembersCommand extends $Command<ListMembersCommandInput, ListMembersCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: ListMembersCommandInput;

package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts

@@ -56,6 +56,27 @@ export interface ListOrganizationAdminAccountsCommandOutput extends ListOrganiza
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To list administrator acccounts for an organization
+ * ```javascript
+ * // The following example lists the Security  Hub administrator accounts for an organization. Only the organization management account can call this operation.
+ * const input = undefined;
+ * const command = new ListOrganizationAdminAccountsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AdminAccounts": [
+ *     {
+ *       "AccountId": "777788889999"
+ *     },
+ *     {
+ *       "Status": "ENABLED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-administrator-acccounts-for-an-organization-1678386548110
+ * ```
+ *
  */
 export declare class ListOrganizationAdminAccountsCommand extends $Command<ListOrganizationAdminAccountsCommandInput, ListOrganizationAdminAccountsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: ListOrganizationAdminAccountsCommandInput;

package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts

@@ -58,6 +58,50 @@ export interface ListSecurityControlDefinitionsCommandOutput extends ListSecurit
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To list security controls that apply to a standard
+ * ```javascript
+ * // The following example lists security controls that apply to a specified Security Hub standard.
+ * const input = {
+ *   "MaxResults": 3,
+ *   "NextToken": "NULL",
+ *   "StandardsArn": "arn:aws:securityhub:::standards/aws-foundational-security-best-practices/v/1.0.0"
+ * };
+ * const command = new ListSecurityControlDefinitionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "NextToken": "U2FsdGVkX1...",
+ *   "SecurityControlDefinitions": [
+ *     {
+ *       "CurrentRegionAvailability": "AVAILABLE",
+ *       "Description": "This AWS control checks whether ACM Certificates in your account are marked for expiration within a specified time period. Certificates provided by ACM are automatically renewed. ACM does not automatically renew certificates that you import.",
+ *       "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/ACM.1/remediation",
+ *       "SecurityControlId": "ACM.1",
+ *       "SeverityRating": "MEDIUM",
+ *       "Title": "Imported and ACM-issued certificates should be renewed after a specified time period"
+ *     },
+ *     {
+ *       "CurrentRegionAvailability": "AVAILABLE",
+ *       "Description": "This control checks whether all stages of Amazon API Gateway REST and WebSocket APIs have logging enabled. The control fails if logging is not enabled for all methods of a stage or if loggingLevel is neither ERROR nor INFO.",
+ *       "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/APIGateway.1/remediation",
+ *       "SecurityControlId": "APIGateway.1",
+ *       "SeverityRating": "MEDIUM",
+ *       "Title": "API Gateway REST and WebSocket API execution logging should be enabled"
+ *     },
+ *     {
+ *       "CurrentRegionAvailability": "AVAILABLE",
+ *       "Description": "This control checks whether Amazon API Gateway REST API stages have SSL certificates configured that backend systems can use to authenticate that incoming requests are from the API Gateway.",
+ *       "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/APIGateway.2/remediation",
+ *       "SecurityControlId": "APIGateway.2",
+ *       "SeverityRating": "MEDIUM",
+ *       "Title": "API Gateway REST API stages should be configured to use SSL certificates for backend authentication"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-security-controls-that-apply-to-a-standard-1678386912894
+ * ```
+ *
  */
 export declare class ListSecurityControlDefinitionsCommand extends $Command<ListSecurityControlDefinitionsCommandInput, ListSecurityControlDefinitionsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: ListSecurityControlDefinitionsCommandInput;

package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts

@@ -58,6 +58,50 @@ export interface ListStandardsControlAssociationsCommandOutput extends ListStand
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To say whether standard
+ * ```javascript
+ * // The following example specifies whether a control is currently enabled or disabled in each enabled standard in the calling account. The response also provides other details about the control.
+ * const input = {
+ *   "SecurityControlId": "S3.1"
+ * };
+ * const command = new ListStandardsControlAssociationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "StandardsControlAssociationSummaries": [
+ *     {
+ *       "AssociationStatus": "ENABLED",
+ *       "RelatedRequirements": [
+ *         "PCI DSS 1.2.1",
+ *         "PCI DSS 1.3.1",
+ *         "PCI DSS 1.3.2",
+ *         "PCI DSS 1.3.4",
+ *         "PCI DSS 1.3.6"
+ *       ],
+ *       "SecurityControlArn": "arn:aws:securityhub:us-west-2:110479873537:security-control/S3.1",
+ *       "SecurityControlId": "S3.1",
+ *       "StandardsArn": "arn:aws:securityhub:us-west-2::standards/pci-dss/v/3.2.1",
+ *       "StandardsControlDescription": "This AWS control checks whether the following public access block settings are configured from account level: ignorePublicAcls: True, blockPublicPolicy: True, blockPublicAcls: True, restrictPublicBuckets: True.",
+ *       "StandardsControlTitle": "S3 Block Public Access setting should be enabled",
+ *       "UpdatedAt": "2022-01-13T23:03:46.648000+00:00"
+ *     },
+ *     {
+ *       "AssociationStatus": "DISABLED",
+ *       "RelatedRequirements": [],
+ *       "SecurityControlArn": "arn:aws:securityhub:us-west-2:110479873537:security-control/S3.1",
+ *       "SecurityControlId": "S3.1",
+ *       "StandardsArn": "arn:aws:securityhub:us-west-2::standards/aws-foundational-security-best-practices/v/1.0.0",
+ *       "StandardsControlDescription": "This AWS control checks whether the following public access block settings are configured from account level: ignorePublicAcls: True, blockPublicPolicy: True, blockPublicAcls: True, restrictPublicBuckets: True.",
+ *       "StandardsControlTitle": "S3 Block Public Access setting should be enabled",
+ *       "UpdatedAt": "2022-08-12T22:59:04.924000+00:00",
+ *       "UpdatedReason": "Not relevant to environment"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-say-whether-standard-1678389297986
+ * ```
+ *
  */
 export declare class ListStandardsControlAssociationsCommand extends $Command<ListStandardsControlAssociationsCommandInput, ListStandardsControlAssociationsCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: ListStandardsControlAssociationsCommandInput;

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -50,6 +50,25 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @example To get a list of tags for a resource
+ * ```javascript
+ * // The following example returns a list of tags associated with the specified resource.
+ * const input = {
+ *   "ResourceArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Tags": {
+ *     "Area": "USMidwest",
+ *     "Department": "Operations"
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-a-list-of-tags-for-a-resource-1678477883796
+ * ```
+ *
  */
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;

package/dist-types/commands/TagResourceCommand.d.ts

@@ -53,6 +53,21 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @example To tag a resource
+ * ```javascript
+ * // The following example adds the 'Department' and 'Area' tags to the specified resource.
+ * const input = {
+ *   "ResourceArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default",
+ *   "Tags": {
+ *     "Area": "USMidwest",
+ *     "Department": "Operations"
+ *   }
+ * };
+ * const command = new TagResourceCommand(input);
+ * await client.send(command);
+ * // example id: to-tag-a-resource-1678478687320
+ * ```
+ *
  */
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: TagResourceCommandInput;

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -53,6 +53,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @example To remove tags from a resource
+ * ```javascript
+ * // The following example removes the 'Department' tag from the specified resource.
+ * const input = {
+ *   "ResourceArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default",
+ *   "TagKeys": [
+ *     "Department"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * await client.send(command);
+ * // example id: to-remove-tags-from-a-resource-1678478903748
+ * ```
+ *
  */
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;

package/dist-types/commands/UpdateActionTargetCommand.d.ts

@@ -55,6 +55,19 @@ export interface UpdateActionTargetCommandOutput extends UpdateActionTargetRespo
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @example To update the name and description of a custom action target
+ * ```javascript
+ * // The following example updates the name and description of a custom action target in Security Hub. You can create custom actions to automatically respond to Security Hub findings using Amazon EventBridge.
+ * const input = {
+ *   "ActionTargetArn": "arn:aws:securityhub:us-west-1:123456789012:action/custom/Remediation",
+ *   "Description": "Sends specified findings to customer service chat",
+ *   "Name": "Chat custom action"
+ * };
+ * const command = new UpdateActionTargetCommand(input);
+ * await client.send(command);
+ * // example id: to-update-the-name-and-description-of-a-custom-action-target-1678814873015
+ * ```
+ *
  */
 export declare class UpdateActionTargetCommand extends $Command<UpdateActionTargetCommandInput, UpdateActionTargetCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: UpdateActionTargetCommandInput;

package/dist-types/commands/UpdateFindingAggregatorCommand.d.ts

@@ -66,6 +66,33 @@ export interface UpdateFindingAggregatorCommandOutput extends UpdateFindingAggre
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @example To update cross-Region aggregation settings
+ * ```javascript
+ * // The following example updates the cross-Region aggregation configuration. You use this operation to change the list of linked Regions and the treatment of new Regions. However, you cannot use this operation to change the aggregation Region.
+ * const input = {
+ *   "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *   "RegionLinkingMode": "SPECIFIED_REGIONS",
+ *   "Regions": [
+ *     "us-west-1",
+ *     "us-west-2"
+ *   ]
+ * };
+ * const command = new UpdateFindingAggregatorCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FindingAggregationRegion": "us-east-1",
+ *   "FindingAggregatorArn": "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *   "RegionLinkingMode": "SPECIFIED_REGIONS",
+ *   "Regions": [
+ *     "us-west-1",
+ *     "us-west-2"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-update-cross-region-aggregation-settings-1678815536396
+ * ```
+ *
  */
 export declare class UpdateFindingAggregatorCommand extends $Command<UpdateFindingAggregatorCommandInput, UpdateFindingAggregatorCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: UpdateFindingAggregatorCommandInput;

package/dist-types/commands/UpdateInsightCommand.d.ts

@@ -310,6 +310,32 @@ export interface UpdateInsightCommandOutput extends UpdateInsightResponse, __Met
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @example To update an insight
+ * ```javascript
+ * // The following example updates the specified Security Hub insight.
+ * const input = {
+ *   "Filters": {
+ *     "ResourceType": [
+ *       {
+ *         "Comparison": "EQUALS",
+ *         "Value": "AwsIamRole"
+ *       }
+ *     ],
+ *     "SeverityLabel": [
+ *       {
+ *         "Comparison": "EQUALS",
+ *         "Value": "HIGH"
+ *       }
+ *     ]
+ *   },
+ *   "InsightArn": "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *   "Name": "High severity role findings"
+ * };
+ * const command = new UpdateInsightCommand(input);
+ * await client.send(command);
+ * // example id: to-update-an-insight-1678816280498
+ * ```
+ *
  */
 export declare class UpdateInsightCommand extends $Command<UpdateInsightCommandInput, UpdateInsightCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: UpdateInsightCommandInput;

package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts

@@ -56,6 +56,17 @@ export interface UpdateOrganizationConfigurationCommandOutput extends UpdateOrga
  *          account or throttling limits. The error code describes the limit exceeded.</p>
  *
  *
+ * @example To update organization configuration
+ * ```javascript
+ * // The following example updates the configuration for an organization so that Security Hub is automatically activated for new member accounts. Only the Security Hub administrator account can call this operation.
+ * const input = {
+ *   "AutoEnable": true
+ * };
+ * const command = new UpdateOrganizationConfigurationCommand(input);
+ * await client.send(command);
+ * // example id: to-update-organization-configuration-1678911630846
+ * ```
+ *
  */
 export declare class UpdateOrganizationConfigurationCommand extends $Command<UpdateOrganizationConfigurationCommandInput, UpdateOrganizationConfigurationCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: UpdateOrganizationConfigurationCommandInput;

package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts

@@ -58,6 +58,18 @@ export interface UpdateSecurityHubConfigurationCommandOutput extends UpdateSecur
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @example To update Security Hub settings
+ * ```javascript
+ * // The following example updates Security Hub settings to turn on consolidated control findings, and to automatically enable new controls in enabled standards.
+ * const input = {
+ *   "AutoEnableControls": true,
+ *   "ControlFindingGenerator": "SECURITY_CONTROL"
+ * };
+ * const command = new UpdateSecurityHubConfigurationCommand(input);
+ * await client.send(command);
+ * // example id: to-update-security-hub-settings-1678912194496
+ * ```
+ *
  */
 export declare class UpdateSecurityHubConfigurationCommand extends $Command<UpdateSecurityHubConfigurationCommandInput, UpdateSecurityHubConfigurationCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: UpdateSecurityHubConfigurationCommandInput;

package/dist-types/commands/UpdateStandardsControlCommand.d.ts

@@ -56,6 +56,19 @@ export interface UpdateStandardsControlCommandOutput extends UpdateStandardsCont
  *  <p>The request was rejected because we can't find the specified resource.</p>
  *
  *
+ * @example To update the enablement status of a standard control
+ * ```javascript
+ * // The following example disables the specified control in the specified security standard.
+ * const input = {
+ *   "ControlStatus": "DISABLED",
+ *   "DisabledReason": "Not applicable to my service",
+ *   "StandardsControlArn": "arn:aws:securityhub:us-west-1:123456789012:control/pci-dss/v/3.2.1/PCI.AutoScaling.1"
+ * };
+ * const command = new UpdateStandardsControlCommand(input);
+ * await client.send(command);
+ * // example id: to-update-the-enablement-status-of-a-standard-control-1678912506444
+ * ```
+ *
  */
 export declare class UpdateStandardsControlCommand extends $Command<UpdateStandardsControlCommandInput, UpdateStandardsControlCommandOutput, SecurityHubClientResolvedConfig> {
     readonly input: UpdateStandardsControlCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-securityhub",
   "description": "AWS SDK for JavaScript Securityhub Client for Node.js, Browser and React Native",
-  "version": "3.316.0",
+  "version": "3.319.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.316.0",
+    "@aws-sdk/client-sts": "3.319.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.316.0",
+    "@aws-sdk/credential-provider-node": "3.319.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
@@ -36,7 +36,7 @@
     "@aws-sdk/middleware-serde": "3.310.0",
     "@aws-sdk/middleware-signing": "3.310.0",
     "@aws-sdk/middleware-stack": "3.310.0",
-    "@aws-sdk/middleware-user-agent": "3.310.0",
+    "@aws-sdk/middleware-user-agent": "3.319.0",
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.310.0",
     "@aws-sdk/protocol-http": "3.310.0",
@@ -48,7 +48,7 @@
     "@aws-sdk/util-body-length-node": "3.310.0",
     "@aws-sdk/util-defaults-mode-browser": "3.316.0",
     "@aws-sdk/util-defaults-mode-node": "3.316.0",
-    "@aws-sdk/util-endpoints": "3.310.0",
+    "@aws-sdk/util-endpoints": "3.319.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",
     "@aws-sdk/util-user-agent-node": "3.310.0",