list_profile_objects ¶

def list_profile_objects(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    object_type_name: "capo_customer_profiles.types.type_name.typeName",
    profile_id: "capo_customer_profiles.types.uuid.uuid",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    next_token: Optional["capo_customer_profiles.types.token.token"] = None,
    max_results: Optional[
        "capo_customer_profiles.types.max_size100.maxSize100"
    ] = None,
    object_filter: Optional[
        "capo_customer_profiles.types.object_filter.ObjectFilter"
    ] = None,
) -> "capo_customer_profiles.types.list_profile_objects_response.ListProfileObjectsResponse":
    """<p>Returns a list of objects associated with a profile of a given ProfileObjectType.</p>

    Args:
        next_token: <p>The pagination token from the previous call to ListProfileObjects.</p>
        max_results: <p>The maximum number of objects returned per page.</p>
        domain_name: <p>The unique name of the domain.</p>
        object_type_name: <p>The name of the profile object type.</p>
        profile_id: <p>The unique identifier of a customer profile.</p>
        object_filter: <p>Applies a filter to the response to include profile objects with the specified index values.</p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_customer_profiles.types.list_profile_objects_request.ListProfileObjectsRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.list_profile_objects_response.ListProfileObjectsResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.list_profile_objects

        output, http_response = (
            capo_customer_profiles._operations.customer_profiles_20200815.list_profile_objects.list_profile_objects(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_customer_profiles.types.list_profile_objects_response.ListProfileObjectsResponse",
    ) -> dict[str, Any]:
        import capo_customer_profiles.types.list_profile_objects_response

        return capo_customer_profiles.types.list_profile_objects_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListProfileObjects", redact_output=_redact_output),
    )
    input_: capo_customer_profiles.types.list_profile_objects_request.ListProfileObjectsRequest = {
        "domain_name": domain_name,
        "object_type_name": object_type_name,
        "profile_id": profile_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if object_filter is not None:
        input_["object_filter"] = object_filter

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