list_handshakes_for_organization ¶

def list_handshakes_for_organization(
    self,
    *,
    config_overrides: Optional[OrganizationsClientConfig] = None,
    filter: Optional[
        "capo_organizations.types.handshake_filter.HandshakeFilter"
    ] = None,
    next_token: Optional["capo_organizations.types.next_token.NextToken"] = None,
    max_results: Optional["capo_organizations.types.max_results.MaxResults"] = None,
) -> "capo_organizations.types.list_handshakes_for_organization_response.ListHandshakesForOrganizationResponse":
    """<p>Lists the recent handshakes that you have sent.</p> <p>You can view <code>CANCELED</code>, <code>ACCEPTED</code>, <code>DECLINED</code>, or <code>EXPIRED</code> handshakes in API responses for 30 days before they are deleted.</p> <p>You can only call this operation from the management account or a member account that is a delegated administrator.</p> <note> <p>When calling List* operations, always check the <code>NextToken</code> response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until <code>NextToken</code> returns null. A null <code>NextToken</code> value indicates that you have retrieved all available results.</p> </note>

    Args:
        filter: <p>A <code>HandshakeFilter</code> object. Contains the filer used to select the handshakes for an operation.</p>
        next_token: <p>The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from.</p>
        max_results: <p>The maximum number of items to return in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that you can retrieve the remaining results.</p>

    Raises:
        capo_organizations.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the <i>IAM User Guide</i>.</p>
        capo_organizations.errors.aws_organizations_not_in_use_exception.AWSOrganizationsNotInUseException: <p>Your account isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.</p>
        capo_organizations.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The target of the operation is currently being modified by a different request. Try again later.</p>
        capo_organizations.errors.invalid_input_exception.InvalidInputException: <p>The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation.</p> </note> <ul> <li> <p>CALLER_REQUIRED_FIELD_MISSING: At least one of the required field is missing: Caller Account Id, Management Account Id or Organization Id.</p> </li> <li> <p>DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.</p> </li> <li> <p>END_DATE_NOT_END_OF_MONTH: You provided an invalid end date. The end date must be the end of the last day of the month (23.59.59.999).</p> </li> <li> <p>END_DATE_TOO_EARLY: You provided an invalid end date. The end date is too early.</p> </li> <li> <p>END_DATE_TOO_LATE: You provided an invalid end date. The end date is too late.</p> </li> <li> <p>IMMUTABLE_POLICY: You specified a policy that is managed by Amazon Web Services and can't be modified.</p> </li> <li> <p>INPUT_REQUIRED: You must include a value for all required parameters.</p> </li> <li> <p>INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.</p> </li> <li> <p>INVALID_END_DATE: The selected withdrawal date doesn't meet the minimum notice period required by your partner agreement. Visit Amazon Web Services Partner Central or contact your Amazon Web Services Channel Partner for help.</p> </li> <li> <p>INVALID_ENUM: You specified an invalid value.</p> </li> <li> <p>INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.</p> </li> <li> <p>INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.</p> </li> <li> <p>INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.</p> </li> <li> <p>INVALID_PAGINATION_TOKEN: Get the value for the <code>NextToken</code> parameter from the response to a previous call of the operation.</p> </li> <li> <p>INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.</p> </li> <li> <p>INVALID_PATTERN: You provided a value that doesn't match the required pattern. The service also validates your free-text field values against common cross-site scripting (XSS) patterns and rejects requests that contain matching values.</p> </li> <li> <p>INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.</p> </li> <li> <p>INVALID_PRINCIPAL: You specified an invalid principal element in the policy.</p> </li> <li> <p>INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix <code>AWSServiceRoleFor</code>.</p> </li> <li> <p>INVALID_START_DATE: The start date doesn't meet the minimum requirements.</p> </li> <li> <p>INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.</p> </li> <li> <p>INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. </p> </li> <li> <p>INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for Amazon Web Services use. System tags don’t count against your tags per resource limit.</p> </li> <li> <p>MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.</p> </li> <li> <p>MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.</p> </li> <li> <p>MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.</p> </li> <li> <p>MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.</p> </li> <li> <p>MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.</p> </li> <li> <p>MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.</p> </li> <li> <p>NON_DETACHABLE_POLICY: You can't detach this Amazon Web Services Managed Policy.</p> </li> <li> <p>START_DATE_NOT_BEGINNING_OF_DAY: You provided an invalid start date. The start date must be the beginning of the day (00:00:00.000).</p> </li> <li> <p>START_DATE_NOT_BEGINNING_OF_MONTH: You provided an invalid start date. The start date must be the first day of the month.</p> </li> <li> <p>START_DATE_TOO_EARLY: You provided an invalid start date. The start date is too early.</p> </li> <li> <p>START_DATE_TOO_LATE: You provided an invalid start date. The start date is too late.</p> </li> <li> <p>TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.</p> </li> <li> <p>UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.</p> </li> <li> <p>UNSUPPORTED_ACTION_IN_RESPONSIBILITY_TRANSFER: You provided a value that is not supported by this operation.</p> </li> </ul>
        capo_organizations.errors.service_exception.ServiceException: <p>Organizations can't complete your request because of an internal service error. Try again later.</p>
        capo_organizations.errors.too_many_requests_exception.TooManyRequestsException: <p>You have sent too many requests in too short a period of time. The quota helps protect against denial-of-service attacks. Try again later.</p> <p>For information about quotas that affect Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html">Quotas for Organizations</a> in the <i>Organizations User Guide</i>.</p>
        capo_organizations.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To retrieve a list of the handshakes associated with an organization
        The following example shows you how to get a list of handshakes associated with the current organization:

        >>> client.list_handshakes_for_organization()
    """

    def _handler(
        req: "OperationRequest[capo_organizations.types.list_handshakes_for_organization_request.ListHandshakesForOrganizationRequest]",
    ) -> OperationResponse[
        "capo_organizations.types.list_handshakes_for_organization_response.ListHandshakesForOrganizationResponse"
    ]:
        import capo_organizations._operations.aws_organizations_v20161128.list_handshakes_for_organization

        output, http_response = (
            capo_organizations._operations.aws_organizations_v20161128.list_handshakes_for_organization.list_handshakes_for_organization(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_organizations.types.list_handshakes_for_organization_response.ListHandshakesForOrganizationResponse",
    ) -> dict[str, Any]:
        import capo_organizations.types.list_handshakes_for_organization_response

        return capo_organizations.types.list_handshakes_for_organization_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListHandshakesForOrganization", redact_output=_redact_output
        ),
    )
    input_: capo_organizations.types.list_handshakes_for_organization_request.ListHandshakesForOrganizationRequest = {}
    if filter is not None:
        input_["filter"] = filter
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output