lib/aws-sdk-securityhub/client.rb in aws-sdk-securityhub-1.42.0 vs lib/aws-sdk-securityhub/client.rb in aws-sdk-securityhub-1.43.0

- old
+ new

@@ -326,25 +326,65 @@ end # @!group API Operations # Accepts the invitation to be a member account and be monitored by the - # Security Hub master account that the invitation was sent from. + # Security Hub administrator account that the invitation was sent from. # # This operation is only used by member accounts that are not added # through Organizations. # # When the member account accepts the invitation, permission is granted - # to the master account to view findings generated in the member + # to the administrator account to view findings generated in the member # account. # + # @option params [required, String] :administrator_id + # The account ID of the Security Hub administrator account that sent the + # invitation. + # + # @option params [required, String] :invitation_id + # The identifier of the invitation sent from the Security Hub + # administrator account. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.accept_administrator_invitation({ + # administrator_id: "NonEmptyString", # required + # invitation_id: "NonEmptyString", # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AcceptAdministratorInvitation AWS API Documentation + # + # @overload accept_administrator_invitation(params = {}) + # @param [Hash] params ({}) + def accept_administrator_invitation(params = {}, options = {}) + req = build_request(:accept_administrator_invitation, params) + req.send_request(options) + end + + # This method is deprecated. Instead, use + # `AcceptAdministratorInvitation`. + # + # Accepts the invitation to be a member account and be monitored by the + # Security Hub administrator account that the invitation was sent from. + # + # This operation is only used by member accounts that are not added + # through Organizations. + # + # When the member account accepts the invitation, permission is granted + # to the administrator account to view findings generated in the member + # account. + # # @option params [required, String] :master_id - # The account ID of the Security Hub master account that sent the + # The account ID of the Security Hub administrator account that sent the # invitation. # # @option params [required, String] :invitation_id - # The ID of the invitation sent from the Security Hub master account. + # The identifier of the invitation sent from the Security Hub + # administrator account. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -2344,20 +2384,20 @@ req = build_request(:batch_import_findings, params) req.send_request(options) end # Used by Security Hub customers to update information about their - # investigation into a finding. Requested by master accounts or member - # accounts. Master accounts can update findings for their account and - # their member accounts. Member accounts can update findings for their - # account. + # investigation into a finding. Requested by administrator accounts or + # member accounts. Administrator accounts can update findings for their + # account and their member accounts. Member accounts can update findings + # for their account. # # Updates from `BatchUpdateFindings` do not affect the value of # `UpdatedAt` for a finding. # - # Master and member accounts can use `BatchUpdateFindings` to update the - # following finding fields and objects. + # Administrator and member accounts can use `BatchUpdateFindings` to + # update the following finding fields and objects. # # * `Confidence` # # * `Criticality` # @@ -3200,14 +3240,14 @@ req = build_request(:create_insight, params) req.send_request(options) end # Creates a member association in Security Hub between the specified - # accounts and the account used to make the request, which is the master - # account. If you are integrated with Organizations, then the master - # account is the Security Hub administrator account that is designated - # by the organization management account. + # accounts and the account used to make the request, which is the + # administrator account. If you are integrated with Organizations, then + # the administrator account is designated by the organization management + # account. # # `CreateMembers` is always used to add accounts that are not # organization members. # # For accounts that are part of an organization, `CreateMembers` is only @@ -3230,21 +3270,21 @@ # # Accounts that are part of an organization do not receive an # invitation. They automatically become a member account in Security # Hub. # - # A permissions policy is added that permits the master account to view - # the findings generated in the member account. When Security Hub is - # enabled in a member account, findings are sent to both the member and - # master accounts. + # A permissions policy is added that permits the administrator account + # to view the findings generated in the member account. When Security + # Hub is enabled in a member account, the member account findings are + # also visible to the administrator account. # - # To remove the association between the master and member accounts, use - # the ` DisassociateFromMasterAccount ` or ` DisassociateMembers ` - # operation. + # To remove the association between the administrator and member + # accounts, use the ` DisassociateFromMasterAccount ` or ` + # DisassociateMembers ` operation. # # @option params [required, Array<Types::AccountDetails>] :account_details - # The list of accounts to associate with the Security Hub master + # The list of accounts to associate with the Security Hub administrator # account. For each account, the list includes the account ID and # optionally the email address. # # @return [Types::CreateMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -3589,11 +3629,11 @@ # resp.products[0].company_name #=> String # resp.products[0].description #=> String # resp.products[0].categories #=> Array # resp.products[0].categories[0] #=> String # resp.products[0].integration_types #=> Array - # resp.products[0].integration_types[0] #=> String, one of "SEND_FINDINGS_TO_SECURITY_HUB", "RECEIVE_FINDINGS_FROM_SECURITY_HUB" + # resp.products[0].integration_types[0] #=> String, one of "SEND_FINDINGS_TO_SECURITY_HUB", "RECEIVE_FINDINGS_FROM_SECURITY_HUB", "UPDATE_FINDINGS_IN_SECURITY_HUB" # resp.products[0].marketplace_url #=> String # resp.products[0].activation_url #=> String # resp.products[0].product_subscription_resource_policy #=> String # resp.next_token #=> String # @@ -3767,17 +3807,17 @@ # Disables Security Hub in your account only in the current Region. To # disable Security Hub in all Regions, you must submit one request per # Region where you have enabled Security Hub. # - # When you disable Security Hub for a master account, it doesn't - # disable Security Hub for any associated member accounts. + # When you disable Security Hub for an administrator account, it + # doesn't disable Security Hub for any associated member accounts. # # When you disable Security Hub, your existing findings and insights and # any Security Hub configuration settings are deleted after 90 days and # cannot be recovered. Any standards that were enabled are disabled, and - # your master and member account associations are removed. + # your administrator and member account associations are removed. # # If you want to save your existing findings, you must export them # before you disable Security Hub. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -3790,37 +3830,57 @@ req = build_request(:disable_security_hub, params) req.send_request(options) end # Disassociates the current Security Hub member account from the - # associated master account. + # associated administrator account. # # This operation is only used by accounts that are not part of an - # organization. For organization accounts, only the master account (the - # designated Security Hub administrator) can disassociate a member - # account. + # organization. For organization accounts, only the administrator + # account can disassociate a member account. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # + # @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisassociateFromAdministratorAccount AWS API Documentation + # + # @overload disassociate_from_administrator_account(params = {}) + # @param [Hash] params ({}) + def disassociate_from_administrator_account(params = {}, options = {}) + req = build_request(:disassociate_from_administrator_account, params) + req.send_request(options) + end + + # This method is deprecated. Instead, use + # `DisassociateFromAdministratorAccount`. + # + # Disassociates the current Security Hub member account from the + # associated administrator account. + # + # This operation is only used by accounts that are not part of an + # organization. For organization accounts, only the administrator + # account can disassociate a member account. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # # @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/DisassociateFromMasterAccount AWS API Documentation # # @overload disassociate_from_master_account(params = {}) # @param [Hash] params ({}) def disassociate_from_master_account(params = {}, options = {}) req = build_request(:disassociate_from_master_account, params) req.send_request(options) end - # Disassociates the specified member accounts from the associated master - # account. + # Disassociates the specified member accounts from the associated + # administrator account. # - # Can be used to disassociate both accounts that are in an organization - # and accounts that were invited manually. + # Can be used to disassociate both accounts that are managed using + # Organizations and accounts that were invited manually. # # @option params [required, Array<String>] :account_ids - # The account IDs of the member accounts to disassociate from the master - # account. + # The account IDs of the member accounts to disassociate from the + # administrator account. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -3953,10 +4013,36 @@ def enable_security_hub(params = {}, options = {}) req = build_request(:enable_security_hub, params) req.send_request(options) end + # Provides the details for the Security Hub administrator account for + # the current member account. + # + # Can be used by both member accounts that are managed using + # Organizations and accounts that were invited manually. + # + # @return [Types::GetAdministratorAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetAdministratorAccountResponse#administrator #administrator} => Types::Invitation + # + # @example Response structure + # + # resp.administrator.account_id #=> String + # resp.administrator.invitation_id #=> String + # resp.administrator.invited_at #=> Time + # resp.administrator.member_status #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/GetAdministratorAccount AWS API Documentation + # + # @overload get_administrator_account(params = {}) + # @param [Hash] params ({}) + def get_administrator_account(params = {}, options = {}) + req = build_request(:get_administrator_account, params) + req.send_request(options) + end + # Returns a list of the standards that are currently enabled. # # @option params [Array<String>] :standards_subscription_arns # The list of the standards subscription ARNs for the standards to # retrieve. @@ -6272,16 +6358,18 @@ def get_invitations_count(params = {}, options = {}) req = build_request(:get_invitations_count, params) req.send_request(options) end - # Provides the details for the Security Hub master account for the - # current member account. + # This method is deprecated. Instead, use `GetAdministratorAccount`. # - # Can be used by both member accounts that are in an organization and - # accounts that were invited manually. + # Provides the details for the Security Hub administrator account for + # the current member account. # + # Can be used by both member accounts that are managed using + # Organizations and accounts that were invited manually. + # # @return [Types::GetMasterAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetMasterAccountResponse#master #master} => Types::Invitation # # @example Response structure @@ -6301,16 +6389,16 @@ end # Returns the details for the Security Hub member accounts for the # specified account IDs. # - # A master account can be either a delegated Security Hub administrator - # account for an organization or a master account that enabled Security - # Hub manually. + # An administrator account can be either the delegated Security Hub + # administrator account for an organization or an administrator account + # that enabled Security Hub manually. # - # The results include both member accounts that are in an organization - # and accounts that were invited manually. + # The results include both member accounts that are managed using + # Organizations and accounts that were invited manually. # # @option params [required, Array<String>] :account_ids # The list of account IDs for the Security Hub member accounts to return # the details for. # @@ -6329,10 +6417,11 @@ # # resp.members #=> Array # resp.members[0].account_id #=> String # resp.members[0].email #=> String # resp.members[0].master_id #=> String + # resp.members[0].administrator_id #=> String # resp.members[0].member_status #=> String # resp.members[0].invited_at #=> Time # resp.members[0].updated_at #=> Time # resp.unprocessed_accounts #=> Array # resp.unprocessed_accounts[0].account_id #=> String @@ -6346,22 +6435,22 @@ req = build_request(:get_members, params) req.send_request(options) end # Invites other AWS accounts to become member accounts for the Security - # Hub master account that the invitation is sent from. + # Hub administrator account that the invitation is sent from. # # This operation is only used to invite accounts that do not belong to # an organization. Organization accounts do not receive invitations. # # Before you can use this action to invite a member, you must first use # the ` CreateMembers ` action to create the member account in Security # Hub. # # When the account owner enables Security Hub and accepts the invitation - # to become a member account, the master account can view the findings - # generated from the member account. + # to become a member account, the administrator account can view the + # findings generated from the member account. # # @option params [required, Array<String>] :account_ids # The list of account IDs of the AWS accounts to invite to Security Hub # as members. # @@ -6435,12 +6524,13 @@ end # Lists all Security Hub membership invitations that were sent to the # current AWS account. # - # This operation is only used by accounts that do not belong to an - # organization. Organization accounts do not receive invitations. + # This operation is only used by accounts that are managed by + # invitation. Accounts that are managed using the integration with AWS + # Organizations do not receive invitations. # # @option params [Integer] :max_results # The maximum number of items to return in the response. # # @option params [String] :next_token @@ -6483,23 +6573,23 @@ req = build_request(:list_invitations, params) req.send_request(options) end # Lists details about all member accounts for the current Security Hub - # master account. + # administrator account. # # The results include both member accounts that belong to an # organization and member accounts that were invited manually. # # @option params [Boolean] :only_associated # Specifies which member accounts to include in the response based on - # their relationship status with the master account. The default value - # is `TRUE`. + # their relationship status with the administrator account. The default + # value is `TRUE`. # # If `OnlyAssociated` is set to `TRUE`, the response includes member - # accounts whose relationship status with the master is set to - # `ENABLED`. + # accounts whose relationship status with the administrator account is + # set to `ENABLED`. # # If `OnlyAssociated` is set to `FALSE`, the response includes all # existing member accounts. # # @option params [Integer] :max_results @@ -6532,10 +6622,11 @@ # # resp.members #=> Array # resp.members[0].account_id #=> String # resp.members[0].email #=> String # resp.members[0].master_id #=> String + # resp.members[0].administrator_id #=> String # resp.members[0].member_status #=> String # resp.members[0].invited_at #=> Time # resp.members[0].updated_at #=> Time # resp.next_token #=> String # @@ -8075,10 +8166,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-securityhub' - context[:gem_version] = '1.42.0' + context[:gem_version] = '1.43.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated